Webhook

URL:
https://<root>/services/<ServiceName>.<ServiceType>/webhooks/<webhookID>
Methods:
GET
Operations:
Edit, Delete, Notification Status
Required Capability:
Access allowed with either the "Feature layer" or "Geoprocessing" privileges, or the Publisher role
Version Introduced:
11.1

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

ParameterDetails

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:

1
https://organization.domain.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:

1
https://organization.domain.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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "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"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close