Webhooks are notifications about events, sent as they occur, such as a statement generation or an account status change. Canopy will send these notifications to a callback URL you provide.
Canopy provides a series of predefined event types that can be configured through the API or servicing UI as desired.
To subscribe through the UI, visit the App Keys section of the Canopy dashboard. At the bottom of the page, you'll see the option to save a webhook URL in Canopy's system. Once you've successfully saved your webhook URL, you can test it by clicking the Test button. This will trigger a POST request with the
test_event request body at your webhook URL.
In general, when a webhook enabled event occurs, Canopy will send an HTTPS POST payload containing information about the event to an endpoint you are hosting. You must have an environment configured to listen for and process these event notifications in order to utilize this functionality.
If you'd like to test webhook functionality in Canopy, but you haven't yet built and exposed a specific webhook handler designed to handle Canopy's predefined webhook event types, we reccommend testing using Webhook.site - an online webhook URL generator. Using this tool, you can create a unique webhook URL to use to subscribe to events in Canopy. As Canopy sends POST requests to this webhook URL, you will see them appear in the webhook.site UI and be able to inspect their payloads and verify that Canopy is behaving as intended.