List subscribable events
Returns the catalog of event types a webhook can subscribe to — the exact values that are valid in the events array of Create a webhook and Update a webhook.
Read this catalog rather than hard-coding a copy of the list. It is the source Kashier validates against, so a list you maintain separately will drift the moment Kashier adds an event, and a subscription containing a value that is not in the catalog is rejected.
Each entry pairs the literal value you subscribe with a human label and the resource it belongs to. There are two families: transaction events, whose value is the operation that produced them (pay, authorize, capture, refund, void, reversal), and transfer events, whose value is the transfer status reached (INITIATED, IN_TRANSIT, TRANSFERRED, FAILED). Casing is significant and matched literally.
Note what is not in the catalog: a card decline, a Meeza payment, an Apple Pay payment and a Fawry payment are all pay events — payment method and outcome are variations inside the payload, not separate event types. Always read data.status rather than treating the arrival of a pay event as proof of payment.
Request
- Base URL: https://test-api.kashier.io
- URL: https://test-api.kashier.io/v2/webhooks/events
- Auth: API key in header Authorization
Response
The event catalog.
Changes
No recorded changes to this operation across all 1 revision of this API.