Webhooks
Listen for Upzelo events so your integration can automatically trigger reactions
Last updated
Listen for Upzelo events so your integration can automatically trigger reactions
Last updated
© 2023 - Upzelo Limited
Upzelo uses webhooks to notify your application when an event happens on your Upzelo account. Webhooks are useful for you to take any action needed for asynchronous events like when a customer cancels their subscription or accepts a discount offer.
Webhooks enable Upzelo to push real-time notifications to your app. We send you a JSON payload to a URL that has been specified in your webhook configuration. You can then use these notifications to execute actions on your own platform.
Create a new webhook in the Upzelo developer dashboard
Create an endpoint on your web app to listen for the webhooks
Handle the request by parsing the payload and returning a 200 response code.
Webhooks are sent within seconds of an event happening on Upzelo.
Upzelo uses exponential backoffs when sending webhooks. What this means is that the time between retries will increase until we hit a maximum limit, or a 200
status code is returned. Below is a table outlining the times between attempts.
Attempt Number | Delay (minutes) |
---|---|
Flow Started - This is when a customer begins a flow via Upzelo.
Flow Abandoned - This is when a flow is started, but not completed after 60 minutes.
Subscription Pause - When a customer accepts a pause offer.
Subscription Skip Charge - When a customer accepts a skip charge offer.
Subscription Plan Change - When a customer accepts a plan change offer.
Subscription Free Period - When a customer accepts a free period offer.
Subscription Discount - When a customer accepts a discount offer.
Subscription Cancelled - When a customer cancels their subscription.
New Request - When a new request enters the system from a Flow