Webhook

Este objeto representa um webhook enviado.

idstring

Identificador exclusivo para o objeto.

Example: webh_63eb84cc5ebbf96915062ecb

subscriptionIdstring

Identificador da assinatura relacionada ao webhook.

Example: subs_63c07a9c8d701377c9423148

entityIdstring

Identificador da entidade relacionada ao webhook.

Example: loan_63c07a9c8d701377c9423148

eventIdstring

Identificador do evento relacionado ao webhook.

Example: evnt_63c07a9c8d701377c9423148

firstTrydate-time

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

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

deliveryAtdate-time

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

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

requestCountnumber

Quantidade de tentativas de entregas foram realizadas.

Example: 1

failCountnumber

Quantidade de tentativas de entregas mal sucedidas realizadas.

Example: 0

statusnumber

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 [

statusCodestring

Status code da resposta retornada.

Example: 429

messagestring

Mensagem da resposta retornada.

Example: Request failed with status code 429

deliveryAtdate-time

Data em que a requisição foi enviada.

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

durationnumber

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

Example: 500

]

request object

urlstring

URL utilizada na requisição.

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

headersstring

Cabeçalhos utilizados na requisição.

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

bodystring

Corpo da requisição.

Example: {"id": "webh_63eb84cc5ebbf96915062ecb"}

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

Webhook

{
  "id": "webh_63eb84cc5ebbf96915062ecb",
  "subscriptionId": "subs_63c07a9c8d701377c9423148",
  "entityId": "loan_63c07a9c8d701377c9423148",
  "eventId": "evnt_63c07a9c8d701377c9423148",
  "firstTry": "2024-02-25T22:38:41.134Z",
  "deliveryAt": "2024-02-25T22:38:41.134Z",
  "requestCount": 1,
  "failCount": 0,
  "status": "delivered",
  "response": [
    {
      "statusCode": 429,
      "message": "Request failed with status code 429",
      "deliveryAt": "2024-02-25T22:38:41.134Z",
      "duration": 500
    }
  ],
  "request": {
    "url": "https://api.example.com/webhook",
    "headers": "{ \"Content-Type\": \"application/json\" }",
    "body": "{\"id\": \"webh_63eb84cc5ebbf96915062ecb\"}"
  },
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z"
}