Webhooks can be used to notify your system any time a record is created, updated, deleted, or a dispatch status is changed.
Add a webhook
Adding a webhook takes two steps:
-
Add a webhook connection
- Open Manage > Integrations > Connections.
- Select Add on the action menu.
- Set Type to Webhook and fill out the URLs to notify when records are added, edited, deleted, or their status changes. You can also specify up to four HTTP headers to send with every request.
- Click Add.
-
Assign the connection to a web service
- Open Manage > Integrations > Web services.
- Select Set Target on the action menu of an existing web service.
- Select your connection in the Connection field. You can also specify which record events should trigger a webhook notification.
- Click Add.
Multiple web services can use the same webhook connection as their target.
Request to your system
Any time records are added, edited, deleted, or their dispatch status is changed using the form and project of a web service with a web hook target, the following POST request will be sent:
Body | Notes |
{ |
|
Response from your system
Your system should respond to the webhook request in one of the following ways:
Code | Body | Notes |
2xx |
{ |
|
2xx | Empty |
|
5xx | Ignored |
|
Other | Ignored |
|
Usage
Immediate response
If it is possible to process the record in under 3 seconds, respond with 200 OK and the final status of the process ("completed" or "failed") in the response body.
Delayed response
If more than 3 seconds is required to process the record, respond with 200 OK and an empty body to the initial request. The status of the webhook notification will be set to "received".
If you wish to update the webhook notification with the final status of the record in your system, send a PUT request using the key value from the original notification request to:
https://api-dot-mydoforms-hrd.appspot.com/api/v2/notifications/{key}
Body | Notes |
{ |
|
This request must be authenticated by including an Authorization header that combines the webservice Id and the webservice password: Bearer {webservice Id}:{webservice password}
Read more about webservice authorization.
Response | Notes |
{ |
Returns the updated notification. |