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, geoprocessing service, and feature service webhooks.
Update organization webhooks in the ArcGIS Portal Directory
To update an organization webhook through the ArcGIS Portal Directory, follow these steps:
Note:
To see an example POST request that updates a webhook's configuration, see the Update Webhook REST API documentation.
- Browse to the ArcGIS Portal Directory and sign in as a member with an administrator role.
Organization webhooks can only be created and managed by administrators with the Organization webhooks privilege or by members who have been assigned the default administrator role.
https://machine.domain.com/webadaptor/sharing/restOnce you are signed in, the User resource endpoint for your account appears.
- Click the Org ID hyperlink or make a request of the following form to access the Portal Self resource page:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scroll to the bottom of the Self resource endpoint and click Webhook > [Webhook] > Update Webhook, where [Webhook] represents the ID or name of a specific webhook, to access the Update Webhook operation.
- Once on the Update Webhook endpoint, modify the following information:
- To update the webhook name, provide a unique name for the webhook in the Name text box.
- If you are using a new webhook receiver or need to update the payload URL for an existing receiver, provide the new URL in the Payload URL text box.
The payload URL will be queried while the webhook is being updated to ensure that a successful connection can be made between the receiver and the ArcGIS Enterprise portal. An example payload is demonstrated below:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - Optionally, add an alphanumerical string that acts as a secret for the webhook, or update a preexisting secret, that can be used to authenticate webhook messages with the receiver. Provide the new or updated secret in the Secret (Optional) text box.
- Optionally, update the deactivation information for the webhook in the Configuration Properties text box.
By default, the webhook will deactivate if five failures over the course of five days have occurred.
- To update the event triggers for a webhook or choose to receive webhooks for all event triggers, select one of the following:
- Click Let me define manually to modify the list of trigger events that will be used for this webhook in the Send me changes for these comma separated events text box. For example, to subscribe to all events pertaining to a specific group in your organization, provide an event trigger similar to the one demonstrated below, where [groupID] represents the unique ID associated with a specific group.
/groups/[groupID]/update - Click Send me everything to subscribe to all supported event triggers and receive notifications for each event as they occur.
- Click Let me define manually to modify the list of trigger events that will be used for this webhook in the Send me changes for these comma separated events text box. For example, to subscribe to all events pertaining to a specific group in your organization, provide an event trigger similar to the one demonstrated below, where [groupID] represents the unique ID associated with a specific group.
- Once the above parameters have been configured, click Update Webhook to submit the request and apply the changes.
Update organization webhooks in ArcGIS Enterprise portal website
To update an organization webhook through the ArcGIS Enterprise portal website, follow these steps:
- 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.
- Browse to Organization > Settings > Webhooks.
- Locate the organization webhook you want to update.
- Click the Options button and click Edit.
- In the Create webhook window, modify the following:
- To update the webhook name, provide a unique name for the webhook in the Name text box.
- 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.
- 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.
- 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.
- If you need to update the payload URL, select Webhook URL and provide the new payload URL for the webhook receiver.
- If you need to update the notebook item, select Notebook and choose the new notebook that will run when the webhook is triggered.
- Optionally, add an alphanumerical string that acts as a secret for the webhook, or update a preexisting secret, that can be used to authenticate webhook messages with the receiver. Provide the new or updated secret in the Secret (Optional) text box.
- Click Update webhook to apply the changes.
Update geoprocessing service webhooks
To update a geoprocessing service webhook's properties, follow these steps:
Note:
Geoprocessing service webhooks can only be created through the ArcGIS Server Administrator Directory. To see an example POST request that updates a geoprocessing service webhook, see the Edit webhook REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Geoprocessing privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the Edit operation for a geoprocessing service by clicking Services > [ServiceName] > Webhooks > [Webhook] > Edit, where [ServiceName] represents the affected geoprocessing service and [Webhook] represents the webhook that will be updated. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > [Webhook] > Edit, where [FolderName] represents the folder where the service is located.
- On the Edit endpoint, modify the following information:
- If updating the webhook name, provide a unique name for the webhook in the Name text box. The provided name can only include alphanumeric values, as using special characters will result in an error message.
- Optionally, add or update a secret key that can be used to authenticate webhook requests with a receiver. Type the new or updated alphanumerical string in the Signature Key text box.
Service webhooks use signature verification to ensure the integrity and security of webhook payloads sent from ArcGIS Enterprise to a webhook receiver. The alphanumerical string inputted to the Signature Key text box is treated as a secret key, which is known, and stored independently by, both ArcGIS Enterprise and the webhook receiver. When a webhook event is triggered, the secret key and payload is hashed using a HMAC-SHA256 algorithm, creating the signature. The signature is then passed in the webhook request as the x-esriHook-Signature header value. When the webhook payload is delivered to the receiver, the receiver uses the secret key and payload to create a signature of its own using the same HMAC-SHA256 algorithm that ArcGIS Enterprise used. If the signature included in the request header matches the recalculated value created by the webhook receiver, the webhook payload can be trusted by the receiver. Otherwise, the receiver may choose to reject the incoming webhook payload.
- If you are using a new receiver or need to update the payload URL, provide the new URL in the Hook URL text box, which will be queried while the webhook is being updated to ensure that a successful connection can be made between the receiver and the deployment's ArcGIS Server.
An example payload URL is demonstrated below:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - To establish a new media type value for the webhook, choose either of the following from the Content Type drop box:
- application/json (default)
- application/x-www-form-urlencoded
- To update the format of a payload, select one of the following from the Payload Format drop box:
- JSON (default)
- PJSON
- Choose to enable or disable callbacks for the webhook by modifying the value selected for the Active parameter. To enable, select true. To disable, select false.
- Once the above parameters have been configured, click Edit to submit the request and apply the changes.
Note:
Unlike organization and feature service webhooks, geoprocessing service webhooks do not have user-defined event triggers. Geoprocessing service webhooks deliver payloads once a geoprocessing job is complete. For more information on the payloads delivered for geoprocessing services, see Payloads.Update feature service webhooks
To update a feature service webhook's properties, follow these steps:
Note:
Feature service webhooks can only be created through the ArcGIS Server Administrator Directory. To see an example POST request that updates a feature service webhook, see the Edit webhook REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Feature layer privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once signed in, browse to the Webhooks resource for a feature service by clicking Services > [ServiceName] > Webhooks > Create, where [ServiceName] represents the service the webhook will be created for. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > Create, where [FolderName] represents the folder where the service is located.
- Once on the Create Webhook endpoint, provide the following information:
- If updating the webhook name, provide a unique name for the webhook in the Name text box. The provided name can only include alphanumeric values, as using special characters will result in an error message.
- To update the event triggers for a webhook, list the event triggers that will be used for this webhook in the Change Type text box. For example, if you want to update the webhook to be invoked whenever any feature service is created, use the following event trigger:
FeaturesCreated - Optionally, add or update a secret key that can be used to authenticate webhook requests with a receiver. Type the new or updated alphanumerical string in the Signature Key text box.
Service webhooks use signature verification to ensure the integrity and security of webhook payloads sent from ArcGIS Enterprise to a webhook receiver. The alphanumerical string inputted to the Signature Key text box is treated as a secret key, which is known, and stored independently by, both ArcGIS Enterprise and the webhook receiver. When a webhook event is triggered, the secret key and payload is hashed using a HMAC-SHA256 algorithm, creating the signature. The signature is then passed in the webhook request as the x-esriHook-Signature header value. When the webhook payload is delivered to the receiver, the receiver uses the secret key and payload to create a signature of its own using the same HMAC-SHA256 algorithm that ArcGIS Enterprise used. If the signature included in the request header matches the recalculated value created by the webhook receiver, the webhook payload can be trusted by the receiver. Otherwise, the receiver may choose to reject the incoming webhook payload.
- If you are using a new receiver or need to update the payload URL, provide the new URL in the Hook URL text box, which will be queried while the webhook is being updated to ensure that a successful connection can be made between the receiver and your deployment's ArcGIS Server.
An example payload URL is demonstrated below:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow - To establish a new media type value for the webhook, choose either of the following from the Content Type drop box:
- application/json (default)
- application/x-www-form-urlencoded
- To update the format of the payload, select one of the following from the Payload Format drop box:
- JSON (default)
- PJSON
- Choose to enable or disable callbacks for the webhook by modifying the value selected for the Active parameter. To enable, select true. To disable, select false.
- Adjust the scheduling for webhooks by modifying the Seconds information in the Schedule text box. For feature services that experience a lot of frequent edits, lower the Seconds value to receive more frequent webhooks with less event information in the payload. For feature services that do not experience frequent changes, raise the value for the Seconds property to receive less frequent webhooks with more event information contained in the payload.
The minimum, and default, value for scheduling is 20 seconds.
- Once the above parameters have been configured, click Edit to submit the request and apply the changes.
Deactivate webhooks
Webhooks can be deactivated manually or, for organization webhooks, once the deactivation policy (set during the webhook's creation) 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, geoprocessing service, and feature service webhooks.
Deactivate organization webhooks in the ArcGIS Portal Directory
To deactivate an organization webhook through the ArcGIS Portal Directory, follow these steps:
Note:
To see an example POST request that deactivates a webhook, see the Deactivate Webhook REST API documentation.
- Browse to the ArcGIS Portal Directory and sign in as a member with an administrator role.
Organization webhooks can only be created and managed by administrators with the Organization webhooks privilege or by members who have been assigned the default administrator role.
https://machine.domain.com/webadaptor/sharing/restOnce you are signed in, the User resource endpoint for your account appears.
- Click the Org ID hyperlink or make a request of the following form to access the Portal Self resource page:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scroll to the bottom of the Self resource endpoint and click Webhook > [Webhook] > Deactivate, where [Webhook] reflects the ID or name of a specific webhook to access the Deactivate operation.
- Once on the Deactivate endpoint, click Deactivate to pause the webhook.
Deactivate organization webhooks in the ArcGIS Enterprise portal website
To deactivate an organization webhook through the ArcGIS Enterprise portal website, follow these steps:
- 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.
- Browse to Organization > Settings > Webhooks.
- Locate the organization webhook you want to deactivate and click Active.
- Click Confirm to pause the webhook.
Deactivate geoprocessing service webhooks
To deactivate all webhooks configured for a geoprocessing service, follow these steps:
Note:
Geoprocessing service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that deactivates all webhooks for a geoprocessing service, see the Deactivate webhooks REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Geoprocessing privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the deactivateAll operation for a geoprocessing service by clicking Services > [ServiceName] > Webhooks > deactivateAll, where [ServiceName] represents the specific geoprocessing service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > deactivateAll, where [FolderName] represents the folder where the service is located.
- Once on the deactivateAll endpoint, click Deactivate All to pause all configured webhooks.
Deactivate feature service webhooks
To deactivate all webhooks configured for a feature service, follow these steps:
Note:
Feature service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that deactivates all webhooks for a feature service, see the Deactivate webhooks REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them.Webhooks can only be created and managed by members assigned the Feature layer privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the deactivateAll operation for a feature service by clicking Services > [ServiceName] > Webhooks > deactivateAll, where [ServiceName] represents the specific feature service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > deactivateAll, where [FolderName] represents the folder where the service is located.
- Once on the deactivateAll endpoint, click Deactivate All to pause all configured webhooks.
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, geoprocessing service, and feature service webhooks.
Activate organization webhooks through the ArcGIS Portal Directory
To activate an organization webhook through the ArcGIS Portal Directory, follow these steps:
Note:
To see an example POST request that activates a webhook, see the Activate Webhook REST API documentation.
- Browse to the ArcGIS Portal Directory and sign in as a member with an administrator role.
Organization webhooks can only be created and managed by administrators with the Organization webhooks privilege or by members who have been assigned the default administrator role.
https://machine.domain.com/webadaptor/sharing/restOnce you are signed in, the User resource endpoint for your account appears.
- Click the Org ID hyperlink or make a request of the following form to access the Portal Self resource page:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scroll to the bottom of the Self resource endpoint and click Webhook > [Webhook] > Activate, where [Webhook] represents the ID or name of a specific webhook to access the Activate operation.
- Once on the Activate endpoint, click Activate to restart the webhook.
Activate organization webhooks through the ArcGIS Enterprise portal website
To activate an organization webhook through the ArcGIS Enterprise portal website, follow these steps:
- 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.
- Browse to Organization > Settings > Webhooks.
- Locate the organization webhook you want to activate and click Inactive.
- Click Confirm to restart the webhook.
Activate geoprocessing service webhooks
To activate all webhooks configured for a geoprocessing service, follow these steps:
Note:
Geoprocessing service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that activates all webhooks for a geoprocessing service, see the Activate webhooks REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Geoprocessing privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the activateAll operation for a geoprocessing service by clicking Services > [ServiceName] > Webhooks > activateAll, where [ServiceName] represents the specific geoprocessing service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > activateAll, where [FolderName] represents the folder where the service is located.
- Once on the activateAll endpoint, click Activate All to resume all paused webhooks.
Activate feature service webhooks
To activate all webhooks configured for a feature service, follow these steps:
Note:
Feature service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that activates all webhooks for a feature service, see the Activate webhooks REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them.Webhooks can only be created and managed by members assigned the Feature layer privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the activateAll operation for a feature service by clicking Services > [ServiceName] > Webhooks > activateAll, where [ServiceName] represents the specific feature service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks > activateAll, where [FolderName] represents the folder where the service is located.
- Once on the activateAll endpoint, click Activate All to resume all paused webhooks.
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, geoprocessing service, or feature service webhooks.
Delete organization webhooks in the ArcGIS Portal Directory
To delete an organization webhook through the ArcGIS Portal Directory, follow these steps:
Note:
To see an example POST request that deletes a webhook, see the Delete Webhook REST API documentation.
- Browse to the ArcGIS Portal Directory and sign in as a member with an administrator role.
Organization webhooks can only be created and managed by members who have been assigned the default administrator role or members who have been assigned the Organization webhooks privilege.
https://machine.domain.com/webadaptor/sharing/restOnce you are signed in, the User resource endpoint for your account appears.
- Click the Org ID hyperlink or make a request of the following form to access the Portal Self resource:
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Scroll to the bottom of the Self resource endpoint and click Webhook > [Webhook] > Delete, where [Webhook] represents the ID or name of a specific webhook to access the Delete operation.
- Once on the Delete endpoint, click Delete to permanently remove the webhook.
Delete organization webhooks in the ArcGIS Enterprise portal website
To update an organization webhook through the ArcGIS Enterprise portal website, follow these steps:
- 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.
- Browse to Organization > Settings > Webhooks.
- Locate the organization webhook you want to update.
- Click the Options button and click Delete.
- In the Delete window, click the Confirm button to permanently remove the webhook.
Delete geoprocessing service webhooks
There are two ways to delete geoprocessing service webhooks. You can either delete all webhooks that are configured for a geoprocessing service or delete an individual webhook. To delete geoprocessing service webhooks, follow these steps:
Note:
Geoprocessing service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that deletes a geoprocessing service webhook, see the Delete webhook REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Geoprocessing privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the Webhooks resource by clicking Services > [ServiceName] > Webhooks, where [ServiceName] represents the specific geoprocessing service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks, where [FolderName] represents the folder where the service is located.
- Once on the Webhooks endpoint, choose to delete all webhooks or delete a specific webhook.
- To delete all configured webhooks for a geoprocessing service, click deleteAll to access the operation endpoint. Once there, click Delete All.
- To delete a specific webhook, click [Webhook] > Delete, where [Webhook] represents the ID for a webhook. Once on the Delete operation endpoint, click Delete.
Delete feature service webhooks
There are two ways to delete feature service webhooks. You can delete all webhooks that are configured for a feature service or delete an individual webhook. To delete feature service webhooks, follow these steps:
Note:
Feature service webhooks can only be managed through the ArcGIS Server Administrator Directory. To see an example POST request that deletes a feature service webhook, see the Delete webhook REST API documentation.
- Browse to the ArcGIS Server Administrator Directory and sign in as a member with the appropriate administrative privileges assigned to them. Webhooks can only be created and managed by members assigned the Feature layer privilege or the default administrator role.
https://machine.domain.com/webadaptor/admin - Once you have signed in, browse to the Webhooks resource by clicking Services > [ServiceName] > Webhooks, where [ServiceName] represents the specific feature service. For services that are housed in specific folders, click Services > [FolderName] > [ServiceName] > Webhooks, where [FolderName] represents the folder where the service is located.
- Once on the Webhooks endpoint, choose to delete all webhooks or delete a specific webhook.
- To delete all configured webhooks for a feature service, click deleteAll to access the operation endpoint. Once there, click Delete All.
- To delete a specific webhook, click [Webhook] > Delete, where [Webhook] represents the ID for a webhook. Once on the Delete operation endpoint, click Delete.