Webhooks

Listar envios de webhook

Histórico de entregas dos webhooks da organização: cada linha é um envio para a sua URL, com o status HTTP que ela respondeu e o total de tentativas. Use para investigar um evento que não chegou. organizationId é obrigatório; refine por carteira, transação, externalId e intervalo de datas.

GEThttps://api.monkeypay.app/api/v2/webhook/resource/send-eventsBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Você

    Tenha o organizationId

    Filtre por externalId ou transactionId

Esta chamada

GETHistórico de entregas

/webhook/resource/send-events

Respostas possíveis

Depois do sucesso

  1. Você

    Concilie os envios failed

    Confirme a transação pela API

Autorização

BearerRequer autenticação Bearer

Parâmetros

x-customer-idstringcabeçalhoopcional

Opcional. A versão atual da API não lê nem grava este header: a organização é sempre deduzida do token bearer. Enviá-lo não altera o resultado da chamada.

<x-customer-id>
organizationIdstringqueryobrigatório

ID da organização

<organizationId>
walletIdstringqueryopcional
<walletId>
externalIdstringqueryopcional
<externalId>
transactionIdstringqueryopcional
<transactionId>
x-timezonestringcabeçalhoopcional

Fuso usado para interpretar os filtros de data. `startDate=2026-08-07` vira 00:00:00.000 e `endDate=2026-08-07` vira 23:59:59.999 **nesse fuso**. Datas enviadas com `Z` ou offset explícito ignoram o header. Ausente, assume `America/Sao_Paulo`. Aceita também `x-time-zone`.

valores: America/Sao_PauloAmerica/ManausAmerica/CuiabaAmerica/Porto_VelhoAmerica/Boa_VistaAmerica/Rio_BrancoAmerica/FortalezaAmerica/RecifeAmerica/BahiaAmerica/BelemAmerica/MaceioAmerica/NoronhaAmerica/New_YorkAmerica/ChicagoAmerica/DenverAmerica/Los_AngelesAmerica/PhoenixAmerica/AnchoragePacific/HonoluluAsia/ShanghaiUTC

America/Sao_Paulo
startDatestringqueryopcional
<startDate>
endDatestringqueryopcional
<endDate>
pageintegerqueryopcional
Intervalo1 ≤ valor
1
limitintegerqueryopcional
Intervalo1 ≤ valor ≤ 100
10

Respostas

1{
2 "error": null,
3 "success": true,
4 "message": "<message>",
5 "data": [
6 {
7 "id": "<id>",
8 "transactionId": "<transaction-id>",
9 "eventType": "<event-type>",
10 "destinationUrl": "<destination-url>",
11 "wallet": {
12 "id": "<id>",
13 "identification": "<identification>"
14 },
15 "organization": {
16 "id": "<id>",
17 "legalName": "<legal-name>"
18 },
19 "status": "completed",
20 "httpCode": 1,
21 "totalAttempts": 1,
22 "durationMs": 1,
23 "sentAt": "<sent-at>"
24 }
25 ],
26 "pagination": {
27 "page": 1,
28 "limit": 1,
29 "totalItems": 1,
30 "totalPages": 1,
31 "hasNextPage": true,
32 "hasPreviousPage": true
33 }
34}

Campos da resposta

errorobjectopcional
<error>
successbooleanopcional
true
messagestringopcional
<message>
dataarrayopcional
<data>
idstring (uuid)opcional
<id>
transactionIdstringopcional
<transactionId>
eventTypestringopcional

Estado que disparou o envio (ex. `completed`).

<eventType>
destinationUrlstringopcional

URL que recebeu o POST.

<destinationUrl>
walletobjectopcional
<wallet>
idstringopcional
<id>
identificationstringopcional
<identification>
organizationobjectopcional
<organization>
idstringopcional
<id>
legalNamestringopcional
<legalName>
statusstringopcional

`completed` quando a sua URL respondeu 2xx; `failed` em resposta diferente de 2xx ou erro de rede; `queued` enquanto um reenvio aguarda na fila.

valores: completedfailedqueued

<status>
httpCodeintegeropcional

Status HTTP que a sua URL respondeu; `null` em erro de rede.

<httpCode>
totalAttemptsintegeropcional

Tentativas feitas para este evento, contando a primeira.

<totalAttempts>
durationMsintegeropcional
<durationMs>
sentAtstring (date-time)opcional
<sentAt>
paginationobjectopcional

Esta rota usa totalItems e hasNextPage, diferente das rotas /resource.

<pagination>
pageintegeropcional
<page>
limitintegeropcional
<limit>
totalItemsintegeropcional
<totalItems>
totalPagesintegeropcional
<totalPages>
hasNextPagebooleanopcional
<hasNextPage>
hasPreviousPagebooleanopcional
<hasPreviousPage>
Credenciais

Requisição

1curl --request GET \
2 --url 'https://api.monkeypay.app/api/v2/webhook/resource/send-events?page=1&limit=10' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": null,
3 "success": true,
4 "message": "<message>",
5 "data": [
6 {
7 "id": "<id>",
8 "transactionId": "<transaction-id>",
9 "eventType": "<event-type>",
10 "destinationUrl": "<destination-url>",
11 "wallet": {
12 "id": "<id>",
13 "identification": "<identification>"
14 },
15 "organization": {
16 "id": "<id>",
17 "legalName": "<legal-name>"
18 },
19 "status": "completed",
20 "httpCode": 1,
21 "totalAttempts": 1,
22 "durationMs": 1,
23 "sentAt": "<sent-at>"
24 }
25 ],
26 "pagination": {
27 "page": 1,
28 "limit": 1,
29 "totalItems": 1,
30 "totalPages": 1,
31 "hasNextPage": true,
32 "hasPreviousPage": true
33 }
34}