Webhook Relays
Webhook Relays allow you to receive real-time updates about a single donation. You can optionally provide your own id and custom metadata to tag the donation as belonging to a specific user in your application.
There are countless uses of Relays that could be specific to your application. Generally, if you want to give your users something when they donate on Tiltify, you can use Relays.
Example Use Cases
-
Your application can distribute some limited in-game content when one of your players donates on Tiltify.
-
Your application can grant your shoppers a coupon for a discount when they make a Donation on Tiltify
-
Your application can award your employees with some additional time off by donating on Tiltify.
Relay Lifecycle
This is the general flow of using a Webhook Relay to track a Donation. Here, the client is the user's web browser and the server is your application.
- Client: User in your application begins intent
- Server: Generate Relay Key using Tiltify API
- Tiltify: Returns a client_key to track a Donation
- Server: Redirect User to Donate on Tiltify
- Client: User completes a Donation on Tiltify
- Tiltify: Sends Webhooks to Webhook Endpoint with Donation updates
- Server: Receive Webhooks and handle Completed Donations and Cancelled Donations