Webhook | ArcGIS REST APIs

URL:: https://<root>/services/<ServiceName>.<ServiceType>/webhooks/<webhookID>
Methods:: GET
Operations:: Edit, Delete, Notification Status
Version Introduced:: 11.1

Access requirements

Required privileges

The Enterprise 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.

Update Delete Security and infrastructure

To access webhook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above in addition to the Feature layer, Geoprocessing, or Organization webhooks privileges.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The resource for an individual webhook, returning the configuration information of a specific webhook for either a geoprocessing service or a feature service. From this resource, administrators can edit the webhook's configuration, or delete the individual webhook rather than deleting all webhooks for a geoprocessing or feature service.

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 an individual geoprocessing service webhook resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/myService.GPServer/webhooks/a6a89a71-2cb1-47ff-89d4-46e6425e2908?f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

The following is a sample request URL used to access an individual feature service webhook resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/myService.FeatureServer/webhooks/a6a89a71-2cb1-47ff-89d4-46e6425e2908?f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response syntax

Use dark colors for code blocksCopy
{
  "id": "<webhook ID>",
  "folderName": "<the service's root folder name>",
  "serviceName": "<the service name>",
  "serviceType": "<the service type>",
  "name": "<webhook name>",
  "signatureKey": "<signature key>",
  "hookUrl": "<payload URL>",
  "active": <true | false>,
  "contentType": "<application/json | application/x-www-form-urlencoded",
  "scheduleInfo": { //The following object is only returned for feature service webhooks, as scheduling info is not applicable to geoprocessing webhooks
    "name": "<user provided schedule name>",
    "state": "enabled",
    "startAt": <time in Epoch>,
    "recurrenceInfo": {
      "interval": <integer value>,
      "frequency": "second"
    }
  },
  "payloadFormat": "<json | pjson>",
  "created": <time in Epoch when the webhook was created>,
  "modified": <time in Epoch when the webhook was last modified>,
  "ownerId": "<username of the webhook's owner>",
  "modifiedId": "<username of the user to last modify the webhook>",
  "changeTypes": ["event triggers"]
}

JSON Response example

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

Use dark colors for code blocksCopy
{
  "id": "8674b8f4-1588-42bf-a529-9923266cb9ed",
  "folderName": "System",
  "serviceName": "CachingControllers",
  "serviceType": "GPServer",
  "name": "TestWebhook",
  "changeTypes": ["*"],
  "signatureKey": "12345ABCDEF",
  "hookUrl": "https://app.logic.azure.com:443/workflows/...",
  "active": true,
  "contentType": "application/json",
  "scheduleInfo": {},
  "payloadFormat": "json",
  "created": 1670618091416,
  "modified": 1670618091416,
  "ownerId": "webhookAdmin",
  "modifiedId": "webhookAdmin"
}

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

Use dark colors for code blocksCopy
{
  "id": "e394baf5-287c-4ea3-a0b0-ad40c3de6ac3",
  "folderName": "Hosted",
  "serviceName": "Test",
  "serviceType": "FeatureServer",
  "name": "TestWebhook",
  "changeTypes": ["*"],
  "signatureKey": "12345ABCDEF",
  "hookUrl": "https://app.logic.azure.com:443/workflows/...",
  "active": true,
  "contentType": "application/json",
  "scheduleInfo": {
    "name": "Every20Seconds",
    "state": "enabled",
    "startAt": 1670617721049,
    "recurrenceInfo": {
      "interval": 20,
      "frequency": "second"
    }
  },
  "payloadFormat": "json",
  "created": 1670617745208,
  "modified": 1670617745208,
  "ownerId": "webhookAdmin",
  "modifiedId": "webhookAdmin"
}