Webhooks
Concept
Section titled “Concept”A Webhook is a notification system also known as a “callback function.” A webhook’s purpose is to transmit data from one application to another in real-time, without the need for a request. To do this, the receiving application sets up an endpoint (a URL on its server where it will receive webhook notifications) and specifies the events for which it wants to be notified.
Thus, whenever one of the events is triggered, the connected tool automatically pushes the data to the server.
The webhook is always initiated by the connected tool. In contrast to an API request, which is a request made by the server to the connected tool to retrieve or modify data.
To use this functionality, you simply need to open an access point (endpoint) on your system capable of interpreting the information sent by ProAbono. Then, configure a webhook in ProAbono by providing the callback URL and selecting the events for which you want to be notified.
Example: If a “SubscriptionStarted” event occurs, a notification is sent to the specified URL (https://mywebsite.com/proabono-events).
Associated Processes
Section titled “Associated Processes”| Actions | Role | Consequences |
|---|---|---|
| Create a webhook | Adds a new callback function, associating one or more events with a destination URL. | - The callback function is configured. - It will not be active until the validation step is completed. |
| Validate a webhook | Validates the proper functioning of exchanges between ProAbono and the third-party application and ensures that the destination application is correct. | - If an event associated with this webhook occurs, notifications will be sent. |
| Modify a webhook | Updates one of the attributes of the callback function: (events, destination URL) | |
| Deactivate a webhook | Suspends the sending of notifications related to this callback function. | - Even if an event associated with this webhook occurs, nothing will happen. - Notifications will not be sent (no HTTP call). |
| Reactivate a webhook | Resumes listening for events and sending notifications. | If an event associated with this webhook occurs, notifications will be sent again. Note: The event history is not retained, so there is no retroactive effect. Events that occurred while the webhook was suspended are lost. |
| Delete a webhook | Removes the callback function from the list. | - Notifications will no longer be sent. - There will be no reference to the webhook in the database. |
Lifecycle
Section titled “Lifecycle”- Once created, a mandatory validation step is required to secure the exchanges and ensure proper reception of the notifications.
- Once validated, a webhook becomes active, triggering the sending of a notification whenever an associated event occurs.
- You can deactivate an active webhook at any time to suspend the sending of notifications while retaining the associated information.
- To resume sending notifications, simply reactivate a suspended webhook.
- If you no longer need a webhook, you can permanently delete it.