Docs
Abrir o painel

Listar eventos

GET
/webhook/{webhook_id}/events

Histórico de entregas de um webhook, com status, código HTTP e tentativas.

Autorização

SecretIDSecretKey
headerX-Secret-ID<token>

ID da credencial de API, gerado no painel.

headerX-Secret-Key<token>

Chave secreta da credencial. Nunca exponha no front-end.

Parâmetros de caminho

webhook_id*string

external_id do webhook.

Formatuuid

Parâmetros de query

page?integer
Range1 <= value
Default1
per_page?integer

Itens por página (máximo 100).

Rangevalue <= 100
Default10
correlation_id?string

ID do pagamento que gerou o evento.

status?string
  • created: aguardando a primeira entrega
  • retrying: falhou e será tentado de novo
  • done: seu endpoint respondeu 2xx
  • failed: falhou após todas as tentativas
Value in"created""retrying""done""failed"

Corpo da resposta

Página de eventos.

application/json
  1. response
page?integer
pages?integer
total?integer
data?array<>
Exemplo de requisição
curl -X GET 'https://sandbox.xpayz.us/payment-link/webhook/497f6eca-6276-4993-bfeb-53cbbbba6f08/events'
Exemplo de resposta
{  "page": 0,  "pages": 0,  "total": 0,  "data": [    {      "external_id": "95c35493-41aa-44f8-9154-5a25cbbc1865",      "correlation_id": "string",      "content": {        "topic": "event.created",        "data": {          "external_id": "string",          "amount": "string",          "currency": "string",          "status": "pending",          "method": "pix",          "payer": {            "name": "string",            "email": "string",            "document": "string"          },          "link": {            "external_id": "string",            "external_ref": "string"          }        }      },      "status": "created",      "status_code": 0,      "retries": 0,      "endpoint": "http://example.com",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}