Skip To Content

Key concepts for webhooks

A webhook provides other applications with event-driven information, delivered as an HTTPS request that can be used to create automated and integrative workflows. Some of the key concepts in ArcGIS Enterprise webhook workflows are described in more detail in the following sections.

Event trigger

An event trigger specifies the API operations that will invoke your webhook. Both organization and feature service webhooks support a variety of event triggers that you can subscribe to. For example, you can set your organization webhook to be triggered when a specific group is updated, or for a feature service webhook you can choose to have the webhook trigger when a feature service's definition is updated. Geoprocessing service webhooks, however, do not use a list of event triggers that users can subscribe to. Rather, geoprocessing service webhooks return payloads whenever a geoprocessing service job has completed. For more information on the supported list of event triggers for organization and feature service webhooks, see the Event triggers topic.

Payload

When a user performs an operation that was specified as an event trigger, the webhook will deliver the event information, also known as the payload, to the specified payload URL. The event information for each webhook type is delivered in a similar JSON schema, containing the event information and when the event occurred, though the payload structure and properties returned for organization and service webhooks vary by webhook type. To learn more about the payloads for each webhook type, see Payloads.

Payload URL

Once a webhook is invoked, the payload is delivered to a specific URL, often provided by the webhook receiver. The payload URL is provided when configuring a webhook, and is checked during creation to ensure that the receiver is reachable by ArcGIS Enterprise with an HTTPS POST request.

Receivers

Payloads are delivered to webhook receivers, which retrieve the payload and communicate that the event has happened back to administrators or organization members. Webhooks receivers must be configured to communicate over a HTTPS connection to receive payloads and be reachable by ArcGIS Enterprise. There are a few options that are supported for receivers, such as third-party web service receivers (Microsoft Power Automate, Zapier, and IFFT), custom web services, ArcGIS Notebook Server, and ArcGIS Workflow Manager. For examples of how to create custom web services, or get started using third-party receivers, see the Webhook repository. To learn more about creating Notebook Server and Workflow Manager webhooks, see Automate workflows with ArcGIS Notebooks and Create jobs with webhooks, respectively.