Pular para o conteúdo principal

Webhooks

Uma lista de webhooks.

    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

  • ]