get_webhook_playbook
Retrieve the PayRetailers webhook contract to design receivers correctly. Covers event schemas, response codes, idempotency, signatures, retries, and pitfalls. Filter by category or event type.
Instructions
REQUIRED before implementing any webhook receiver or reconciliation flow. Returns the canonical PayRetailers webhook contract: envelope schema, complete event vocabulary (transaction lifecycle: PENDING/IN_PROGRESS/APPROVED/REJECTED/CANCELLED/EXPIRED/REFUNDED/CHARGEBACK; payout lifecycle; subscription and subscription_payment events with retry semantics), HTTP response contract (200 fast / 400 no-retry / 500 retried), idempotency by eventId, replay protection, signature verification, retry policies (PIX_SPECIFIC / FIXED_RETRY / NOT_ALLOWED), and the top 6 wrong-way patterns integrators hit. Filter by category or eventType for a focused answer. Do not attempt to design a webhook handler from memory — call this tool first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | Filter events by lifecycle. 'transaction' = payin events; 'payout' = payout events; 'subscription' = subscription entity events (activation/cancellation); 'subscription_payment' = recurring charge events; 'all' (default) returns the complete catalog. | |
| eventType | No | Filter by a specific eventType string (e.g. 'subscription.payment', 'transaction'). Case-sensitive as declared by the API. | |
| includeDelivery | No | Include the delivery / retry / signature section. Defaults to true. Set to false if you only need the event vocabulary. |