Listar webhooks enviados

GET

webhooks

curl --request GET \
  --url https://api.base39.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

event_id

string

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

subscription_id

string

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

entity_id

string

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

string

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

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.

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.

ending_before

string

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 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.

Response

200 - application/json

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

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"

curl --request GET \
  --url https://api.base39.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

Visão geral

Ingestão de dados

Consulta de dados

Listar webhooks enviados

Authorizations

Query Parameters

Response