Manage webhooks

As an administrator, you can update and manage webhooks by updating their configuration (such as updating the event triggers the webhook is subscribed to), as well as disabling and deleting previously configured webhooks.

Update webhooks

You can update the configured parameters for webhooks after creation. The sections below outline how to update properties for organization and service webhooks.

Update organization webhooks

To update an organization webhook through the ArcGIS Enterprise portal website, follow these steps:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage organization webhooks.
2. Browse to Organization > Settings > Webhooks.
3. Under Organization webhooks, locate the webhook you want to update.
4. Click the Options button and click Edit.
5. In the Edit webhook window, modify the following:
   1. To update the webhook name, provide a unique name for the webhook in the Name text box.
   2. To update the webhook type, click the Type drop-down menu and select a new webhook type.
      • Selecting All subscribes you to all supported event triggers. You will receive notifications for each event as they occur.
      • Selecting Items, Users, Groups, or Roles allows you to manually define which trigger events you want to subscribe to.
   3. If you select a webhook type other than All, an additional drop-down menu will appear, relative to the webhook type that was chosen. For example, if you selected Items for the webhook type, the Items drop-down menu appears, allowing you to select a specific item the webhook will monitor.
   4. To update the event triggers, click the Events drop-down menu and select a new trigger event. For example, if you want the webhook to be invoked when a specific item is published, select /items/<item ID>/publish.
   5. If you need to update the payload URL, select Webhook URL and provide the new payload URL for the webhook receiver.
   6. If you need to update the notebook item, select Notebook and choose the new notebook that will run when the webhook is triggered.
   7. Optionally, add an alphanumerical string that acts as a secret for the webhook, or update a preexisting secret, in the Secret (Optional) text box. The secret value will be used to generate a signature that is included in the webhook payload headers. The webhook receiver can use this signature to determine if the message should be trusted.
6. Click Update webhook to apply the changes.

Update service webhooks

To update a service webhook's properties, follow these steps:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage service webhooks.

   Note:

   Members assigned the publisher role will be unable to create or manage service webhooks from the ArcGIS Enterprise portal site and will need to perform these workflows using the administrative API.

2. Browse to Organization > Settings > Webhooks.
3. Under Service webhooks, locate the webhook you want to update.
4. Click the Options button and click Edit.
5. In the Edit webhook window, modify the following:
   1. To update the webhook name, provide a unique name for the webhook in the Name text box.
   2. To update the service the webhook is associated with, click the Service drop-down menu and select a new service.

      Note:

      Selecting a geoprocessing service will set the event as Service is finished. Selecting a feature service will enable the Events drop-down menu.

   3. If you select a feature service webhook, select new event triggers from the Events drop-down menu. For example, if you want the webhook to be invoked when a feature attachment is updated, select AttachmentsUpdated.
   4. If you need to update the payload URL, select Webhook URL and provide the new payload URL for the webhook receiver.
   5. Optionally, add an alphanumerical string that acts as a secret for the webhook, or update a preexisting secret, in the Secret (Optional) text box. The secret value will be used to generate a signature that is included in the webhook payload headers. The webhook receiver can use this signature to determine if the message should be trusted.
6. Click Update webhook to apply the changes.

Deactivate webhooks

Webhooks can be deactivated manually or once the deactivation policy is met. When a webhook is deactivated, the webhook is paused and is unable to deliver payloads when they are triggered. The sections below outline how to deactivate organization and service webhooks.

Deactivate organization webhooks

To deactivate an organization webhook through the ArcGIS Enterprise portal website, follow these steps:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage organization webhooks.
2. Browse to Organization > Settings > Webhooks.
3. Under Organization webhooks, locate the organization webhook you want to deactivate and click Active.
4. Click Confirm to pause the webhook.

Deactivate service webhooks

To deactivate a service webhook, do the following:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage service webhooks.

   Note:

   Members assigned the publisher role will be unable to create or manage service webhooks from the ArcGIS Enterprise portal site and will need to perform these workflows using the administrative API.

2. Browse to Organization > Settings > Webhooks.
3. Under Service webhooks, locate the service webhook you want to deactivate and click Active.
4. Click Confirm to pause the webhook.

Activate webhooks

While a webhook is deactivated, it will be unable to deliver payloads. Reactivating a webhook restarts the webhook and enables it to deliver payloads when the webhook is next invoked. The sections below outline how to activate previously deactivated organization and service webhooks.

Activate organization webhooks

To activate an organization webhook through the ArcGIS Enterprise portal website, follow these steps:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage organization webhooks.
2. Browse to Organization > Settings > Webhooks.
3. Under Organization webhooks, locate the organization webhook you want to activate and click Inactive.
4. Click Confirm to restart the webhook.

Activate service webhooks

To activate a service webhook, do the following:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage service webhooks.

   Note:

   Members assigned the publisher role will be unable to create or manage service webhooks from the ArcGIS Enterprise portal site and will need to perform these workflows using the administrative API.

2. Browse to Organization > Settings > Webhooks.
3. Under Service webhooks, locate the service webhook you want to activate and click Inactive.
4. Click Confirm to restart the webhook.

Delete webhooks

If a previously created webhook is no longer needed, you can permanently remove the webhook from your organization by deleting it. The following sections outline how to delete organization and service webhooks.

Delete organization webhooks

To update an organization webhook through the ArcGIS Enterprise portal website, follow these steps:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage organization webhooks.
2. Browse to Organization > Settings > Webhooks.
3. Under Organization webhooks, locate the organization webhook you want to update.
4. Click the Options button and click Delete.
5. In the Delete window, click the Confirm button to permanently remove the webhook.

Delete service webhooks

To delete a service webhook, do the following:

1. Verify that you are signed in as a default administrator or a member of a custom role with administrative privileges to create and manage service webhooks.

   Note:

   Members assigned the publisher role will be unable to create or manage service webhooks from the ArcGIS Enterprise portal site and will need to perform these workflows using the administrative API.

2. Browse to Organization > Settings > Webhooks.
3. Under Service webhooks, locate the service webhook you want to update.
4. Click the Options button and click Delete.
5. In the Delete window, click the Confirm button to permanently remove the webhook.