- Webhooks — Paxos pushes a notification to your endpoint when something happens
- Events API — You poll the Events API to fetch events on your own schedule
Webhook Payload Pattern
Paxos webhooks use a reduced-payload approach. The webhook notification contains a summary (event ID, type, source, and timestamp) but not the full resource. Your application must callGetEvent to fetch the complete event details.
This pattern ensures that sensitive data is only delivered through authenticated API calls.
Webhook Endpoint Security
Paxos authenticates with your webhook endpoint using one of two methods. Configure these in the Dashboard:- API Key — Set a custom header name and value. Paxos includes this header in every webhook request. Validate it in your handler.
- OAuth — Provide your OAuth token endpoint. Paxos obtains a token from your endpoint before calling your webhook.
Paxos does not currently sign webhook payloads. Payload signing is planned for a future release. In the meantime,
ParseEvent fetches the canonical event from the API to ensure authenticity.Polling with the Events API
As an alternative to webhooks, poll the Events API to fetch events:Common Event Types
| Event Type | Description |
|---|---|
identity.approved | Identity has been approved for transactions |
identity.denied | Identity verification was denied |
transfer.crypto.deposit.completed | Crypto deposit confirmed on-chain |
transfer.crypto.withdrawal.completed | Crypto withdrawal confirmed on-chain |
transfer.wire.deposit.completed | Wire deposit has arrived |
transfer.wire.withdrawal.completed | Wire withdrawal has been sent |
orchestration.completed | Stablecoin orchestration finished successfully |
orchestration.failed | Stablecoin orchestration failed |
Handling Events Idempotently
Webhooks may be delivered more than once. Deduplicate by tracking theevent.id:
For more details on webhook configuration and retry behavior, see the Webhooks Guide.