Webhooks is a mechanism whereby when changes occur on registered events in infoodle we publish a notification to a configured URL. That URL can then process the webhook to retrieve the associated data or any other tasks. These are preferable to using a Poll to keep on checking looking for changes.
Usage
The typical usage of webhooks in infoodle is that we send out basic anonymous information. This is sent using the role of the user who setup the webhook to ensure that you are getting only data relevant to you.
Having received the data - it will always contain an ID. You will then use that ID to call infoodle through the API to get further details that you may need, e.g. when a form entry is submitted the ID of that form entry is sent - you then use the form entry fields api end point to pull full details of that form entry. That call is also validated against the credentials you have used to access the API to ensure you have access to that specific form entry.
Sending webhooks
Infoodle will send out the webhook at the time the event happens. If the call fails we retry this on a reduced frequency. If this repeatedly fails we will pause the webhook delivery and you will need to manually restart the webhook once you are satisfied its working again.
Add a webhook
To receive a webhook response you need to Add the webhook. See Adding a webhook for details.
List of Webhooks
To access webhooks you need to go to the administration menu and click the Webhooks link.
This screen lists all the current webhooks and their current status.
The 3 icons on each webhook allows:
- Edit webhook
- Run webhook
- Delete webhook