Lista os eventos de webhook

GET/v1/webhooks/events

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
typestring
Só eventos deste tipo.
Valores:transaction.createdtransaction.pendingtransaction.failedtransaction.approvedtransaction.canceledtransaction.chargebacktransaction.refundedtransaction.fraud-reviewtransaction.pre-authorizedtransaction.unauthorizedtransaction.awaitingtransaction.disputecustomer.createdcustomer.updatedcustomer.deletedcustomer.address.createdcustomer.address.updatedcustomer.address.deletedcard.createdcard.updatedcard.deletedcard.expiredsubscription.createdsubscription.pendinge mais 62
resourcestring
Só eventos deste recurso (ex.: transaction).
resourceIdstring
Só os eventos deste id de recurso.
statusstring
delivered ou failed.
Valores:deliveredfailed
eventIdstring
Só este evento.
endpointstring
URL (ou parte dela) de um endpoint para o qual o evento foi entregue.
resourceidstring
Apelido de resourceId.
eventidstring
Apelido de eventId.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+12 campos de data
- idstringobrigatório
  Identificador público (wbh_…)
- dataany
  O conteúdo do evento, como enviado à sua URL.
- typestringobrigatório
  Tipo do evento, no formato recurso.acao.
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- sourcestringobrigatório
  Origem do evento na plataforma.
- attemptsintegerobrigatório
  Tentativas de entrega feitas, somando todos os endpoints.
- merchantobject
  A conta dona do recurso (o vendedor de registro).
  +3 campos de merchant
  - namestringobrigatóriopode ser nulo
    Nome fantasia da conta dona do recurso.
  - merchantIdstringobrigatóriopode ser nulo
    Id público da conta dona do recurso (bus_…).
  - isSubAccountbooleanobrigatório
    true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
- resourcestringobrigatório
  O recurso de que o evento trata (ex.: transaction).
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- deliveredbooleanobrigatório
  Se todos os endpoints assinantes receberam a entrega com sucesso.
- dispatchesobject[]
  As entregas deste evento, uma por endpoint (só na leitura individual).
  +14 campos de dispatches
  - idstringobrigatório
    Identificador público (wdi_…)
  - statusstringobrigatório
    pending, success, failed, retrying ou canceled.
    Valores:pendingsuccessfailedretryingcanceled
  - eventIdstringobrigatóriopode ser nulo
    O evento entregue; null numa entrega sintética (ping de teste).
  - attemptsintegerobrigatório
    Tentativas feitas até agora.
  - endpointstringobrigatório
    A URL para onde foi entregue.
  - createdAtstringobrigatório
    Quando o recurso foi criado (ISO 8601, UTC).
  - eventTypestringobrigatóriopode ser nulo
    Tipo do evento entregue (ex.: transaction.approved); null numa entrega sintética.
  - successAtstringobrigatóriopode ser nulo
    Quando a entrega deu certo; null até lá.
  - endpointIdstringobrigatóriopode ser nulo
    O endpoint para onde foi entregue.
  - responseBodystringobrigatóriopode ser nulo
    Corpo que o seu endpoint respondeu (primeiros 8 KB); null quando não houve.
  - responseTimeintegerobrigatóriopode ser nulo
    Quanto tempo o seu endpoint levou para responder, em milissegundos.
  - lastAttemptAtstringobrigatóriopode ser nulo
    Quando a última tentativa foi feita.
  - nextAttemptAtstringobrigatóriopode ser nulo
    Quando a próxima tentativa está marcada; null quando não há.
  - responseStatusCodeintegerobrigatóriopode ser nulo
    Status HTTP que o seu endpoint respondeu; null quando não respondeu.
- resourceIdstringobrigatóriopode ser nulo
  Id público desse recurso.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorExclui um endpoint de webhook PróximaEnvia um ping de teste para conferir a integração

{ "data": [ { "id": "wbh_0a1b2c3d4e5f60718293", "type": "string", "_links": {}, "source": "string", "attempts": 0, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "resource": "string", "createdAt": "string", "delivered": true, "dispatches": [ { "id": "wdi_0a1b2c3d4e5f60718293", "status": "pending", "eventId": "wbh_0a1b2c3d4e5f60718293", "attempts": 0, "endpoint": "string", "createdAt": "string", "eventType": "string", "successAt": "string", "endpointId": "wbe_0a1b2c3d4e5f60718293", "responseBody": "string", "responseTime": 0, "lastAttemptAt": "string", "nextAttemptAt": "string", "responseStatusCode": 0 } ], "resourceId": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }