Set up a Webhook

Prerequisites

1. Complete the getting started tutorial to learn about how to set up a basic Action.
2. Set up a Webhook to create a connection to an external system. You may need to work with a system administrator who has permissions to connect to source systems before creating a Webhook.

Steps

In the below example, suppose that we have a Webhook called Modify ticket priority which accepts a priority string value and sends it to an external system.

Navigate to your Action, select the Logic tab, select Add new rule, then select Webhook.

By default, the newly added Webhook is configured as a side effect; this makes the Webhook run after objects are edited in Foundry. Alternatively, select Writeback to have the Webhook run before object edits.

In the menu below, select the Webhook you want to execute. In this example, we select the Modify ticket priority Webhook. If you wish, you can select a different version of the Webhook.

Next, configure Webhook input parameters based on Action parameters. By default, a new Action parameter is generated for each Webhook input unless an existing Action parameter with the same name already exists, in which case the existing parameter is automatically configured. In this example, we map the Webhook input called priority to an existing Action parameter called Ticket Priority.

Select Add webhook to complete adding the Webhook rule to your Action. Note that after the Webhook is added, the Rules section shows that the writeback will occur before objects are modified.

You may want to remove any autogenerated parameters created when you added the Webhook which are now unused.

Select Save in the top-right to save your changes to the Action. Now, when the Action is applied, the request to the external system will be made before any changes are applied to objects in Foundry.

Next steps

This tutorial demonstrated how to add a Webhook to an Action. To learn more, try these resources:

• View the Webhooks section to learn about all the options available for Webhooks in Actions.
• Learn how to configure Webhook input parameters using Functions.
• Learn more about the Webhooks concept in Data Connection.