Webhooks

URL:: https://<root>/services/<ServiceName>.<ServiceType>/webhooks
Methods:: GET
Operations:: Create, Delete All, Activate All, Deactivate All
Child Resources:: Webhook
Required Capability:: Access allowed with either the "Feature layer" or "Geoprocessing" privileges, or the Publisher role
Version Introduced:: 11.1

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 usage

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.domain.com/context/admin/services/myService.GPServer/webhooks?f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

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.domain.com/context/admin/services/myService.FeatureServer/webhooks?f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response example

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"
    }
  ]
}