iHook
iHook is a module inside of iDMS that allows the creation of one or more webhook endpoints in conjunction with inserting a panel or activity record in iMIS.
iHook (formerly iTransfer Webhooks, or iTransfer Inbound Transfers) is now accessed entirely from the iWorkflow UI.
Included Triggers and Actions
The following triggers(s) are available within the iHook module:
The following action(s) are available within the iHook module:
Calling a Webhook
For information about what types of HTTP requests are accepted by the Webhook trigger, please refer to the Webhook trigger documentation.
Webhook Responses
| Status Code | Reason |
|---|---|
| 200 |
Webhook queued successfully for processing. |
| 202 |
Alternate of 200 OK for compatibility reasons. Does not support polling at this time. |
| 400 |
The body was not in JSON format, or the workflow URL is invalid. |
| 401 |
The webhook URL or token is invalid. |
| 500 |
A server error occurred. Contact CSI for assistance. |
Response Body
The webhook will include a JSON response body (of type application/json) by default, which includes the unique workflow run ID as well as the queue time.
This body can be omitted by enabling the Omit Response Body option on the webhook trigger.
CORS
CORS headers are enabled on all webhook endpoints by default. Webhooks can be invoked from JavaScript if desired.
iTransfer Webhook Analog
To recreate the iTransfer webhook behavior, set up the following workflow:
Trigger: Webhook
- Leave default values set.
Action 1: JSON Schema Validate
- Paste the JSON schema into the schema property of this action.
Action 2: Insert Activity
- Map or hard-code any necessary activity values.
Note: Template syntax has changed - instead of $$propertyName$$, the new syntax is {{ propertyName }}. For more information, please see the Template Engine page.