Pular para o conteúdo principal

Listar webhooks enviados

GET 
/v1/webhooks

Retorna todos os webhooks enviados, ordenados por data de criação, mais recentes primeiro.

Request​

Query Parameters

    event_id string

    Filtro por campo id do evento. O valor pode ser uma string ou uma lista separada por vírgula.

    Examples:

    Valor único

    Example: evnt_63eb84cc5ebbf96915062ec9

    subscription_id string

    Filtro por campo id da assinatura. O valor pode ser uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: subs_63eb84cc5ebbf96915062ec9

    entity_id string

    Filtro por campo id da entidade. O valor pode ser uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: loan_63eb84cc5ebbf96915062ec9

    id string

    Filtro por campo id de um webhook enviado. O valor pode ser uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: webh_63eb84cc5ebbf96915062ec9

    expand string

    Expande as referências.

    Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

    Example: data.loan
    starting_after string

    Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

    Example: obj_5f92f01728e009f403d8502e
    ending_before string

    Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

    Example: obj_5f92f01728e009f403d8502e
    limit integer

    Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

    Default value: 10
    Example: 10
    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

Responses​

Um objeto com data contendo um array de Webhook a partir de starting_after. Se vazio, indica fim dos itens.

Schema

    hasMore boolean

    Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

    Example: true

    data

    object[]

    Uma lista de webhooks enviados

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: webh_63eb84cc5ebbf96915062ecb
    subscriptionId string

    Identificador da assinatura relacionada ao webhook.

    Example: subs_63c07a9c8d701377c9423148
    entityId string

    Identificador da entidade relacionada ao webhook.

    Example: loan_63c07a9c8d701377c9423148
    eventId string

    Identificador do evento relacionado ao webhook.

    Example: evnt_63c07a9c8d701377c9423148
    firstTry date-time

    Data em que houve a primeira tentativa de envio do webhook.

    Example: 2024-02-25T22:38:41.134Z
    deliveryAt date-time

    Data em que o webhook foi enviado com sucesso pela primeira vez.

    Example: 2024-02-25T22:38:41.134Z
    requestCount number

    Quantidade de tentativas de entregas foram realizadas.

    Example: 1
    failCount number

    Quantidade de tentativas de entregas mal sucedidas realizadas.

    Example: 0
    status number

    Indica o progresso da entrega do webhook, com quatro estados possíveis: inProgress: Ainda há tentativas pendentes, sem entregas bem-sucedidas.delivered: Pelo menos uma entrega foi bem-sucedida.failed: Todas as 3 tentativas falharam.retrying: Novas tentativas após falhas iniciais, sem sucessos prévios. O sistema atualiza automaticamente esse status com base no resultado das tentativas de entrega.

    Example: delivered

    response

    object[]

  • Array [

    • statusCode string

    Status code da resposta retornada.

    Example: 429
    message string

    Mensagem da resposta retornada.

    Example: Request failed with status code 429
    deliveryAt date-time

    Data em que a requisição foi enviada.

    Example: 2024-02-25T22:38:41.134Z
    duration number

    Duração da requisição em milissegundos.

    Example: 500

  • ]

    • request

    object

    url string

    URL utilizada na requisição.

    Example: https://api.example.com/webhook
    headers string

    Cabeçalhos utilizados na requisição.

    Example: { "Content-Type": "application/json" }
    body string

    Corpo da requisição.

    Example: {"id": "webh_63eb84cc5ebbf96915062ecb"}
    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z

  • ]

Loading...