- URL:https://[root]/portals/[portalID]/webhooks
- Operations:Create Webhook
- Child Resources:List a Specific Webhook, Settings
- Version Introduced:10.7
Example usage
The following is a sample ArcGIS Enterprise request URL used to access the webhooks resource:
https://machine.domain.com/webadaptor/sharing/rest/portals/123456789ABCDEF/webhooks?f=pjsonDescription
The webhooks resource returns a list of all organization webhooks for your ArcGIS Enterprise portal. This will include both activated and deactivated webhooks. Starting with ArcGIS Enterprise 11.1, pagination was added to the webhooks resource that allows for organizations that have more than 25 configured webhooks.
Note:
ArcGIS Enterprise supports organization, feature service, and geoprocessing webhooks. The ArcGIS Portal Directory allows for the creation and management of organization webhooks, whereas the ArcGIS Server Administrative API Directory supports the creation and management of geoprocessing and feature service webhooks. For information on how to configure service webhooks in ArcGIS Enterprise, see either the ArcGIS Server Admin API webhook documentation or the Manage webhooks in ArcGIS Enterprise administrative documentation. ArcGIS Online also supports feature service webhooks, which are managed in the ArcGIS Online Administrative Services Directory. To learn more about ArcGIS Online feature service webhooks, see the Web Hooks API documentation.
Request parameters
| Parameter | Details |
|---|---|
| start (Optional) | Introduced at ArcGIS Enterprise 11.1. The number of the first entry in the result set response. The index number is 1-based, and the default value begins at 1. Example |
| num (Optional) | Introduced at ArcGIS Enterprise 11.1. The maximum number of results to be included in the result set response. The default value is 25. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
JSON Response examples
Below is a sample JSON response of the webhooks resource, demonstrating webhooks that do not contain any additional properties:
{
"total": 1,
"start": 1,
"num": 25,
"nextStart": -1,
"webhooks": [
{
"id": "7c001f61f51e440baa81ab0616dc4143",
"accountId": "0123456789ABCDEF",
"payloadUrl": "https://machineName:8000",
"secret": "",
"isActive": true,
"name": "All Updates",
"config": {
"deactivationPolicy": {
"numberOfFailures": 5,
"daysInPast": 5
}
},
"ownerId": "86ccfe86be2d490a8507eaea82749dc6",
"modifiedId": "86ccfe86be2d490a8507eaea82749dc6", //Introduced at ArcGIS Enterprise 11.1
"created": 1548281793118,
"modified": 1548281793118,
"events": [
"/"
]
}
]
}Below is a sample JSON response of the webhooks resource, demonstrating an ArcGIS Notebook Server webhook:
{
"total": 1,
"start": 1,
"num": 25,
"nextStart": -1,
"webhooks": [
{
"id": "7c001f61f51e440baa81ab0616dc4143",
"accountId": "0123456789ABCDEF",
"payloadUrl": "https://machineName:8000",
"secret": "",
"isActive": true,
"name": "All Updates",
"config": {
"deactivationPolicy": {
"numberOfFailures": 5,
"daysInPast": 5
},
"properties": {
"federatedServer": {
"serverId": "t4IGVvF82xlnxjLT",
"itemId": "9a401d61f15a740baa81ab0616dc222",
"tokenTypeToSend": "user",
"tokenExpirationTimeMinutes": "10"}
},
"ownerId": "86ccfe86be2d490a8507eaea82749dc6",
"modifiedId": "86ccfe86be2d490a8507eaea82749dc6", //Introduced at ArcGIS Enterprise 11.1
"created": 1548281793118,
"modified": 1548281793118,
"events": [
"/"
]
}
]
}