Skip to main content
This endpoint returns a log of all webhook delivery attempts made by CertoPay to your registered endpoint. Each record captures the event type, delivery outcome, HTTP response received from your server, and the time the delivery was attempted. Use the optional query parameters to filter by delivery status or event type — for example, to surface only failed deliveries that need attention or retrying.

​
Endpoint

GET https://v2.certopaybrasil.com/api/webhooks/deliveries

​
Authentication

All requests must include your secret API key in the X-Api-Key header.
​
X-Api-Key
string
required
Your CertoPay secret API key (e.g. sk_live_sua_chave_aqui).

​
Query Parameters

​
status
string
Filter deliveries by their outcome. Accepted values: SUCCESS, FAILED, PENDING. Omit this parameter to return deliveries of all statuses.
​
event
string
Filter deliveries by the event type that triggered them (e.g. transaction.paid, transaction.failed, transaction.refunded). Omit this parameter to return deliveries for all event types.

​
Example Requests

Retrieve all failed deliveries: 
curl "https://v2.certopaybrasil.com/api/webhooks/deliveries?status=FAILED" \
  -H "X-Api-Key: sk_live_sua_chave_aqui"
Retrieve all deliveries for transaction.paid events: 
curl "https://v2.certopaybrasil.com/api/webhooks/deliveries?event=transaction.paid" \
  -H "X-Api-Key: sk_live_sua_chave_aqui"
Combine filters to retrieve failed transaction.paid deliveries: 
curl "https://v2.certopaybrasil.com/api/webhooks/deliveries?status=FAILED&event=transaction.paid" \
  -H "X-Api-Key: sk_live_sua_chave_aqui"

​
Response

Returns an array of webhook delivery objects ordered by most recent attempt first.

​
200 — Success

[
  {
    "deliveryId": "uuid-da-entrega",
    "event": "transaction.paid",
    "status": "FAILED",
    "httpStatus": 500,
    "attemptedAt": "2026-06-26T10:05:30Z"
  },
  {
    "deliveryId": "uuid-da-entrega-2",
    "event": "transaction.created",
    "status": "SUCCESS",
    "httpStatus": 200,
    "attemptedAt": "2026-06-26T10:00:05Z"
  }
]

​
Response Fields

​
deliveryId
string
Unique identifier (UUID) for this delivery attempt. Use this value with POST /api/webhooks/deliveries//retry to manually retry a failed delivery.
​
event
string
The event type that triggered this delivery (e.g. transaction.paid, transaction.failed).
​
status
string
Outcome of the delivery attempt. Possible values: SUCCESS, FAILED, PENDING.
​
httpStatus
integer
The HTTP status code returned by your endpoint when CertoPay attempted delivery (e.g. 200, 500, 404). This field may be null if the request never reached your server (e.g. due to a DNS or connection error).
​
attemptedAt
string
ISO 8601 timestamp for when this delivery was attempted.
Use this endpoint together with POST /api/webhooks/deliveries//retry to recover missed events. Retrieve the deliveryId of any failed delivery from this list, then pass it to the retry endpoint to re-trigger the notification.