Create and manage webhook connections

Available with Workflow Manager license.

License:

This functionality requires a license for the ArcGIS Workflow Manager Advanced organization extension.

In ArcGIS Workflow Manager, you can create webhook connections to add webhook dependency holds to steps.

You must enable workflow management in the Organization extensions settings of your ArcGIS organization before you can create webhook connections.

Learn more about the requirements to create a webhook

Create webhook connections

To create webhook connections, complete the following steps:

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Note:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Webhook Configuration .

   Note:

   If you don't have sufficient privileges, Webhook Configuration is not available.

4. Click the Webhook Connections tab.

   The ArcGIS Webhook Connections panel appears.

5. Click Create New.
6. Click Browse to choose a feature layer.

   Ensure the feature layer meets the prerequisites for creating webhooks.

7. Choose a supported event trigger:
   • FeaturesEdited—A feature is edited, for example, an insertion, an update, or a deletion
   • FeaturesUpdated—A feature is updated

   Note:

   Only the owner of the associated feature service or a portal administrator can configure event triggers.

8. Provide a name for the webhook connection in the Connection Name text box.
9. Click the Run As drop-down arrow and choose a webhook account.

   Note:

   Currently, only built-in users are supported.

10. Optionally, add the current user account as a new webhook account.
    1. Click Opt in as user.

       The Opt in to use my account dialog box appears.

    2. Click Opt in.
11. Optionally, add a different user account as a webhook account.
    1. Click Add webhook account.

       The Add webhook account dialog box appears.

    2. Provide the credentials for the new webhook account.
    3. Click Verify to validate and add the webhook account.
12. Optionally, configure a backup webhook account.
    1. Click Enable fallback user.
    2. Click the Fallback user drop-down arrow and choose a webhook account.

    Note:

    The feature layer must be shared with the user accounts specified for Run As or Fallback.

13. Optionally, complete the preceding steps to add more webhook accounts.
14. Optionally, provide a secret key for added security.

    This key is used to generate a signature that is included in the webhook payload headers. The webhook receiver can use this signature to determine whether the message should be trusted. The webhook receiver must already exist, and it must be configured to communicate over a secure HTTPS connection.

15. Click Save to save the webhook connection.

    The webhook URL appears.

Edit webhook connections

To edit webhook connections, complete the following steps:

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Note:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Webhook Configuration .

   Note:

   If you don't have sufficient privileges, Webhook Configuration is not available.

4. Click the Webhook Connections tab.

   The ArcGIS Webhook Connections panel appears.

5. Click the name of the webhook connection that you want to edit.

   Tip:

   You can filter the list of webhook connections using the Search Webhook Connections text box.

6. Update the webhook connection as necessary.

   Caution:

   After you create the webhook connection, you can only update the following properties:

   • Connection name
   • Run as user
   • Secret
7. Click Save.

Delete webhook connections

Deleting a webhook connection is permanent and can't be undone.

To delete a webhook connection, complete the following steps:

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Note:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Webhook Configuration .

   Note:

   If you don't have sufficient privileges, Webhook Configuration is not available.

4. Click the Webhook Connections tab.

   The ArcGIS Webhook Connections panel appears.

5. Click the name of the webhook connection that you want to delete.

   Tip:

   You can filter the list of webhook connections using the Search Webhook Connections text box.

6. Click More Actions and choose Delete webhook connection.

   A confirmation message appears.

7. Click Yes to confirm or No to cancel.

Manage webhook connections

You can review and manage user accounts that are associated with webhook connections by completing the following steps:

1. Click the Webhook Accounts tab to see the accounts that are associated with the webhook connections.
2. Optionally, click Remove user from webhooks on an account to remove a user account from all webhook connections.

   Note:

   After a user is removed from all associated webhook connections, they are opted out of running webhook actions with that account. If they want to be associated with new webhook connections, they must provide their credentials to opt in again.