- URL:https://[root]/portals/[portalID]/webhooks/[webhookID]/notificationStatus
- Version Introduced:10.7
Example usage
Below is a sample ArcGIS Enterprise POST request for the notificationStatus resource:
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/webhooks/7c001f61f51e440baa81ab0616dc4143/notificationStatus?f=pjsonDescription
The notificationStatus resource page displays information pertaining to trigger events associated with the specified organization webhook. This response can be used to monitor the webhook, as it returns the details of any delivered payloads such as the time the webhook was triggered, the response received from the payload URL, and the delivered payload data.
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 |
|---|---|
| f | The response format. The default format is html. Values: html | json | pjson |
JSON Response example
{
"total": 2,
"start": 1,
"num": 25,
"nextStart": -1,
"WebhookStatus": [
{
"id": "7c001f61f51e440baa81ab0616dc4143",
"isInvoked": true,
"invokedTimestamp": "2019-01-23 14:26:44.644",
"responseText": "{\"success\":\"true\"}",
"payload": "{\"info\":{\"webhookId\":\"7c001f61f51e440baa81ab0616dc4143\",\"webhookName\":\"Webhook Test\",\"portalURL\":\"https://portal.com/portalWA/\",\"when\":1548282404622},\"events\":[{\"userId\":\"86ccfe86be2d490a8507eaea82749dc6\",\"username\":\"admin\",\"when\":1548282404620,\"operation\":\"share\",\"source\":\"item\",\"id\":\"d1e9a46a0b844e46a2d9ae6b581d0c3c\",\"properties\":{\"sharedToGroups\":\"[Organization]\"}}]}"
},
{
"id": "7c001f61f51e440baa81ab0616dc4143",
"isInvoked": true,
"invokedTimestamp": "2019-01-23 14:26:37.132",
"responseText": "{\"success\":\"true\"}",
"payload": "{\"info\":{\"webhookId\":\"7c001f61f51e440baa81ab0616dc4143\",\"webhookName\":\"Webhook Test\",\"portalURL\":\"https://portal.com/portalWA/\",\"when\":1548282396697},\"events\":[{\"userId\":\"86ccfe86be2d490a8507eaea82749dc6\",\"username\":\"admin\",\"when\":1548282396682,\"operation\":\"share\",\"source\":\"item\",\"id\":\"d1e9a46a0b844e46a2d9ae6b581d0c3c\",\"properties\":{\"sharedToGroups\":\"[Everyone]\"}}]}"
}
]
}Sample payload structure
Below is a sample payload included in the notificationStatus JSON response, formatted for readability. The payload will follow a similar JSON schema with information that is relevant to the event. For more information, see the Webhooks topic.
...
"payload": {
"info": {
"webhookID": "d2273e07339840e0b8a836fce564478b",
"webhookName": "Group monitoring",
"portalURL": "https://machineURL/portal",
"when": 1543192196521
},
"events": [
{
"userId": "7a54f8cea29c404cbebf739cf1108653",
"username": "admin",
"when": 1543192196310,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}