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

Este objeto representa um webhook enviado.

data.id

string

Identificador exclusivo para o objeto.

Example:

"webh_63eb84cc5ebbf96915062ecb"

data.subscriptionId

string

Identificador da assinatura relacionada ao webhook.

Example:

"subs_63c07a9c8d701377c9423148"

data.entityId

string

Identificador da entidade relacionada ao webhook.

Example:

"loan_63c07a9c8d701377c9423148"

data.eventId

string

Identificador do evento relacionado ao webhook.

Example:

"evnt_63c07a9c8d701377c9423148"

data.firstTry

string

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

Example:

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

data.deliveryAt

string

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

Example:

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

data.requestCount

number

Quantidade de tentativas de entregas foram realizadas.

Example:

1

data.failCount

number

Quantidade de tentativas de entregas mal sucedidas realizadas.

Example:

0

data.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"

data.response

object[]

data.request

object

data.createdAt

string

Data de criação do objeto

Example:

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

data.updatedAt

string

Data de alteração do objeto

Example:

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

Webhook FileLinkCreate

{
  "hasMore": true,
  "data": [
    {
      "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"
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos