Webhooks - Service | ArcGIS REST APIs

URL:: https://<root>/services/<serviceName>.<serviceType>/webhooks
Methods:: GET
Operations:: Create, Delete All, Deactivate All, Activate All
Child Resources:: Webhook
Version Introduced:: 11.1

Access requirements

Required privileges

The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Feature layer Geoprocessing

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.

Learn how to generate a token

Description

The webhooks resource returns a list of service webhooks configured for a specific geoprocessing or feature service, including deactivated and activated webhooks. In ArcGIS Enterprise, webhooks provide other applications and webhook receivers with event-driven information, delivered as an HTTPS POST request, that can be used to create automated and integrative workflows. For more information about how webhooks are supported in ArcGIS Enterprise, see Webhooks in ArcGIS Enterprise.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usages

The following is a sample request URL used to access the webhooks resource for a geoprocessing service:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/myService.GPServer/webhooks?f=pjson

The following is a sample request URL used to access the webhooks resource for a feature service:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/myService.FeatureServer/webhooks?f=pjson

JSON Response examples

The following is a sample JSON Response for a geoprocessing service webhooks resource:

Use dark colors for code blocksCopy
{
  "webhooks": [
    {
      "id": "265af3e1-8075-4ed8-978a-59067d7539ef",
      "folderName": "",
      "serviceName": "myService",
      "serviceType": "GPServer",
      "name": "WebHook1",
      "changeTypes": ["*"],
      "signatureKey": "mySecret",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "active": false,
      "contentType": "application/json",
      "payloadFormat": "json",
      "created": "Fri Apr 22 12:51:54 PDT 2022",
      "modified": "Fri Apr 22 12:51:54 PDT 2022"
    },
    {
      "id": "3a4a775a-4e20-43d9-add6-9fb974245e53",
      "folderName": "gp_Services",
      "serviceName": "MyOtherService",
      "serviceType": "GPServer",
      "name": "WebHook2",
      "changeTypes": ["*"],
      "signatureKey": "",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "active": true,
      "contentType": "application/json",
      "payloadFormat": "json",
      "created": "Fri Apr 22 14:55:57 PDT 2022",
      "modified": "Fri Apr 22 15:38:52 PDT 2022"
    }
  ]
}

The following is a sample JSON Response for a feature service webhooks resource:

Use dark colors for code blocksCopy
{
  "webhooks": [
    {
      "name": "Webhook1",
      "service":"MyFS",
      "serviceType": "FeatureServer",
      "changeTypes": ["FeaturesUpdated"],
      "id": "7510236d-6f94-4b19-b58f-841cced2caf1",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "signatureKey": "",
      "active": false,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1650641579145,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "format": "json",
      "created": "Apr 22, 2022, 3:33:06 PM",
      "modified": "Apr 22, 2022, 3:33:06 PM"
    },
    {
      "name": "WebHook2",
      "service":"My2ndFS",
      "serviceType": "FeatureServer",
      "changeTypes": ["*"],
      "id": "80fd5c68-fcd8-4b34-91b2-5330680ef1ea",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "signatureKey": "secretPhrase",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1650998656698,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "format": "json",
      "created": "Apr 26, 2022, 6:48:05 PM",
      "modified": "Apr 26, 2022, 6:48:05 PM"
    }
  ]
}