Webhooks: connect your own site or tools

A webhook sends a message to a web address you choose each time something happens on your page. Use it to update your own website, or connect a tool like Zapier (use its “Catch Hook” trigger).

1. 1Open Integrations and add a webhook: a name and an https web address.
2. 2Choose which events to receive.
3. 3Use Send a test to check your address. Each delivery shows in the log with your server’s reply.

The events:

• support.created: someone supported you (one-off cups, a monthly gift or a membership payment, including each renewal).
• support.refunded: a payment was refunded, fully or in part.
• subscription.cancelled: a monthly gift or membership ended.

Each message is JSON with event_id, type, live_mode (false for tests), created (a Unix time), attempt and data. data has the amount (for example "5.00" and amount_cents 500), currency, cups, kind (tip, monthly or membership), the supporter’s name and email, their message and page_url.

Only show a supporter’s message publicly when is_public is true. Private messages, anonymous supporters and messages still being checked come with is_public false.

Checking a message is really from us: each one has an x-kasdatay-signature header. Work out the HMAC-SHA256 of the raw request body, using your signing secret as the key, and compare it with the header. If they don’t match, ignore the message. You can make a new secret at any time; the old one stops working straight away.

Your address should reply with a 2xx status within 15 seconds. If it doesn’t, we try again after 15, 30, 45 and 60 minutes, with the same event_id, so ignore any event_id you’ve already handled. After 10 failed deliveries in a row we switch the webhook off and email you. Fix the address, then tick On and save.