/[webhookID]/notificationStatus: Notification Status—ArcGIS REST APIs

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=pjson

Description

Note:

ArcGIS Enterprise administrators can use webhooks to track organizational events associated with items, groups, and members. An additional set of webhooks are available to support administration for feature service workflows in ArcGIS Online. For information, see Web Hooks (Feature Service).

The notificationStatus resource page will display information pertaining to trigger events associated with the specified webhook. You can use this table to monitor your webhook and 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.

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": {}
    }
  ]
}