Configuring Webhooks

A Webhook starts the configured task URL when a selected iXpole action occurs. This is part of Workflow configuration and is also useful to developers working with the iXpole API.

In this article you will learn how to configure and check a Webhook

Add a Webhook

  1. Create and test the receiving Task first. Use a task with the Webhook trigger type and copy its URL from the task details.
  2. Open Admin >> Workflow and click Add in Webhooks.
  3. Select the event Action and enter a clear Description.
  4. Paste the task URL into Task.
  5. If only certain records should trigger the webhook, enter a Filter query that returns one boolean field named value.
  6. Choose the Version required by the receiving task.
  7. Set Active and click Save.

Webhook settings

Check and change a Webhook

Trigger the selected action with a safe test record. Open the receiving task's History tab and the Workflow page's Log shortcut to check the result. Select the webhook in the list to change it, or use its active control to pause it.

Note An integration-managed system webhook shows its integration name and cannot be modified in this dialog. Ask the integration owner to change it.

Note Treat a task URL or hash as a secret if possession of it can trigger work. Do not include it in screenshots or public examples.