POST
request to your configured endpoint.
X-Webhook-Token
. Your endpoint must verify this header’s value against the one you have on file with us. Only process the request if they match.
Example of a webhook request with authentication:
Event Type | Description |
---|---|
payment.status-updated | Triggered whenever a payment’s status changes. |
invoice.status-updated | Triggered whenever an invoice’s status changes. |
id
: A unique identifier (UUID) for the webhook event.
event
: The event type, such as payment.status-updated
or invoice.status-updated
.
payload
: An object containing the event-specific data (described below).
X-Webhook-Token
header is included separately from the JSON payload.
payment.status-updated
)invoice.status-updated
)created
, pending
, paid
, failed
, canceled
, expired
bolepix
open
, closed
, paid
, canceled
end_of_cycle
, billing_end_day_updated
not_applicable
, not_initiated
, pending
, success
, failed
AC
, AL
, AP
, AM
, BA
, CE
, DF
, ES
, GO
, MA
, MT
, MS
, MG
, PA
, PB
, PR
, PE
, PI
, RJ
, RN
, RS
, RO
, RR
, SC
, SP
, SE
, TO
Brasil
X-Webhook-Token
Header: Ensure it matches the token you have registered.
event
and payload
.
payment.status-updated
Example Request: