Webhooks send information when certain events take place that affect a service. In ArcGIS Online, you can create webhooks for the feature services that populate hosted feature layers, hosted feature layer views, and hosted tables, and define the events that cause the webhooks to be invoked.
The item must have the Keep track of changes to the data (add, update, delete features) editing setting enabled before you can create or manage a webhook for it.
Create a webhook
You can create a webhook for a hosted feature layer, hosted feature layer view, or hosted table to use triggers and messaging that can notify or support automation of tasks for these items.
The infrastructure to support webhooks is configured outside ArcGIS. For information about what you must configure before you can create a webhook and information about what privileges are required to create webhooks, see Webhooks in ArcGIS Online.
To create a webhook for a hosted feature layer, hosted feature layer view, or hosted table, complete the following steps:
- Sign in to the organization.
- Open the item page of the hosted feature layer, view, or table.
- Click the Settings tab.
- Scroll to the Webhooks section, and click Create webhook.
If the Create webhook button is disabled, the layer may not have the Keep track of changes to the data (add, update, delete features) option enabled.
For views, the Keep track of changes to the data (add, update, delete features) option must be enabled on the source hosted feature layer.
- Provide a name for the webhook.
- Expand the Events menu, and check all the event check boxes that you want to trigger a webhook.
- In the Webhook receiver URL text box, provide the URL of the webhook receiver.
The webhook receiver must already exist, and it must be configured to communicate over a secure HTTPS connection.
- Optionally, provide a secret key for added security.
You must configure the secret key on the webhook receiver before you provide it for the webhook.
- Provide a name for the webhook.
The webhook appears in the list of webhooks for this item.
Manage webhooks
You can manage webhooks from the Settings tab of the item page.
Item owners can also access and manage all the webhooks they own from My settings.
Tip:
Organization administrators have access to and can manage all webhooks in the organization from the Organization > Settings > Webhooks tab. Refer to Manage webhooks across the organization for more information.
Management of a webhook associated with a hosted feature layer, hosted feature layer view, or hosted table includes the following:
- Inactivate or activate the webhook—When a webhook is inactive, it does not fire when the triggering events defined for it occur. You might inactivate all webhooks on a layer temporarily while you perform automated updates to avoid filling your inbox with messages. Or you might temporarily inactivate one webhook that fires for all possible events and leave another webhook active that fires on a single trigger to allow you to temporarily focus on that one event.
- Edit the webhook—You can change the settings for the webhook. For example, you can add a secret key or change the event triggers that cause the webhook to fire.
- Delete the webhook—If a webhook is no longer needed, you can delete it.
Note:
Webhooks are immediately deleted. They do not move to the recycle bin.
Manage a webhook from the item page
To manage a webhook from the item page of the hosted feature layer, hosted feature layer view, or hosted table with which it is associated, complete the following steps:
- Sign in to the organization.
- Open the item page of the hosted feature layer, view, or table.
- Click the Settings tab, and scroll to the webhooks section.
All webhooks associated with this item are listed here.
- Perform one of the following management tasks:
- To inactivate the webhook, disable the toggle button next to the webhook's name.
- To activate the webhook, enable the toggle button next to the webhook's name.
- To edit the settings for a webhook, click the Options button
next to the webhook's name, and click Edit. Change the name, events, webhook receiver URL, or secret key for the webhook, and click Update webhook. - To delete a webhook, click the Options button
next to the webhook's name, and click Delete. When prompted to confirm, click Delete.
Manage a webhook from My settings
To manage webhooks from My settings, complete the following steps:
- Sign in to the organization.
- Click your member name at the top of the site, and click My settings.
- Click the Webhooks tab.
- Perform one of the following management tasks:
- To inactivate the webhook, disable the toggle button next to the webhook's name.
- To activate the webhook, enable the toggle button next to the webhook's name.
- To edit the settings for a webhook, click the Options button
next to the webhook's name, and click Edit. Change the name, events, webhook receiver URL, or secret key for the webhook, and click Update webhook. - To delete a webhook, click the Options button
next to the webhook's name, and click Delete. When prompted to confirm, click Delete.