- URL:
- https://<root>/services/<serviceName>.<serviceType>/webhooks/<webhookID>
- Methods:
GET- Operations:
- Edit, Delete, Notification Status
- 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.
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 generate 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.
Description
The resource for an individual webhook returns the configuration information for either a geoprocessing service or a feature service webhook. 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 |
|---|---|
| The response format. The default format is Values: |
Example usages
The following is a sample request URL used to access an individual geoprocessing service webhook resource:
https://organization.example.com/<context>/admin/services/myService.GPServer/webhooks/a6a89a71-2cb1-47ff-89d4-46e6425e2908?f=pjsonJSON Response syntax
{
"id": "<webhook ID>",
"folderName": "<the service's root folder name>",
"serviceName": "<the service name>",
"serviceType": "<the service type>",
"name": "<webhook name>",
"changeTypes": ["event triggers"],
"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>"
}JSON Response examples
The following is a sample JSON Response for a geoprocessing service webhook resource:
{
"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"
}