webhooks: Webhooks

URL:
https://[root]/portals/[portalID]/webhooks
Methods:
GET
Operations:
Create Webhook, List Service Webhooks
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:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/sharing/rest/portals/123456789ABCDEF/webhooks?f=pjson

Description

The webhooks resource returns a list of all organization webhooks for your ArcGIS Enterprise portal. This will include both activated and deactivated webhooks.

Request parameters

ParameterDetails

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:

Use dark colors for code blocksCopy
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
{

  "webhooks": [
    {
      "id": "7c001f61f51e440baa81ab0616dc4143",
      "accountId": "0123456789ABCDEF",
      "payloadUrl": "https://machineName:8000",
      "secret": "",
      "isActive": true,
      "name": "All Updates",
      "config": {
        "deactivationPolicy": {
          "numberOfFailures": 5,
          "daysInPast": 5
        }
      },
      "ownerId": "86ccfe86be2d490a8507eaea82749dc6",

      "created": 1548281793118,
      "modified": 1548281793118,
      "events": [
        "/"
      ]
    }
  ]
}

Below is a sample JSON response of the webhooks resource, demonstrating an ArcGIS Notebook Server webhook:

Use dark colors for code blocksCopy
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
27
28
29
30
31
32
{
  "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",
        "created": 1548281793118,
        "modified": 1548281793118,
        "events": [
          "/"
        ]
      }
    }
  ]
}

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