A Webhook is a small piece of code attached to a Web application that listens for specific triggers and then performs a predetermined action. Webhooks make it possible to automate processes that previously had to be scheduled.
In Xtendis, Webhooks can be used to notify your application when certain events occur in Xtendis.
Example: You might want to alert and respond in your remote application when metadata for a document has been updated.
When a defined event occurs, a HTTP POST with the event payload is sent to the URL that is configured in the Webhook.
Subscribing to events using a Webhook means that your application does not have to periodically poll Xtendis (via the REST APIs) to determine whether changes have occurred.
Managing Webhooks
Managing Webhooks is done on the Webhooks page in the Functional management section of Xtendis.
From the menu, choose Webhooks to access the Webhooks page.
Creating a Webhook
Step 1. Click Create.
The Create Webhook dialog appears.
Step 2. Configure the options as follows:
| Option | Description |
|---|---|
| Name | Enter a descriptive name. |
| Archive | Choose the archive on which the trigger should react. |
| Callback URL | Enter the URL that should listen for the trigger. |
| Is active | Clear when the Webhook should be temporarily disabled instead of deleting it. |
|
Field Trigger fields |
The Fields list shows all available fields to use as a trigger. Which fields appear depends on the archive that was selected in the Archive field above. To use a field, double-click it. It is added to the Trigger fields list. To remove a field from the Trigger fields list, double-click it. |
Step 3. When done, click Save.
The Webhook is added to the overview.
Editing a Webhook
To edit an existing Webhook, double-click it in the list.
The Edit Webhook dialog appears which is identical to the Create Webhook dialog described above.
Deleting a Webhook
To delete a Webhook, click its trash can icon at the far right of the page and confirm the action.
Comments
0 comments
Please sign in to leave a comment.