Organization Listing (Webhooks) | ArcGIS REST APIs

URL:: https://<root>/WebHooks?
Methods:: POST
Version Introduced:: June, 2024

Description

The organization webhooks API allows a organization administrator to manage and control all webhooks within an organization.

Pagination

The resultOffset and resultRecordCount parameters allows a client to query a designated amount of webhook results at a time, significantly improving the user experience and the loading time of web pages. It also makes navigation through multiple pages much more accessible, especially on mobile devices.

Request parameters

Property	Details
`resultOffset`	This value determines the starting point for displaying records in a list. When not specifying a value for the `resultOffset` the default value will be 0.
`resultRecordCount`	This value indicates the total number of records available in the list. The value must be an integer between 1 and 100. When not specifying a value for the `resultRecordCount`, the maximum number configured by the server administrator, which is 100.
`exceedTransferLimit`	The `exceedTransferLimit` property as `true` will be included in the JSON response when paging through a webhooks query results and it indicates that there are more query results so you can continue to query for the next page. When `exceedTransferLimit` is `false`, it will not be included in the JSON response and it indicates that you have reached the end of the query results. Values: `true` \| `false`
`orderBy`	The organization administrator can use the `orderBy` parameter to decide how to list the webhooks. By default, the list is ordered by `serviceName`. Values: `owner` \| `serviceName` \| `serviceItemId` \| `CreationDate` \| `lastUpdateDate` \|
`user`	The organization administrator can also search the webhooks owned by specific owners. Values: `<userName>`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

Below is a sample request URL used to access the Webhooks resource:

In this example the result will start at record 0 and return results for 2 records.

Use dark colors for code blocksCopy
https://myserver.domain.com/myTenant/ArcGIS/rest/admin/WebHooks?resultOffset=0&resultRecordCount=2

JSON Response examples

The following demonstrates the type of response that is returned when the exceedTransferLimit parameter is set as true:

Use dark colors for code blocksCopy
[
{

  "exceededTransferLimit" : true,
  "webhooks" : [
      {
         "name" : "test_hook_1",
         "owner" : "testAdmin1",
         "id" : 5183, ... },

      {
         "name" : "test_hook_1",
         "owner" : "testAdmin1",
         "id" : 5183, ... }, ...

    ]
}
]

JSON Response example

The following demonstrates the type of response that is returned when the exceedTransferLimit parameter is set as false:

Use dark colors for code blocksCopy
[
    {
       "name" : "test_hook_1",
       "owner" : "testAdmin1",
       "id" : 5183, ... },

    {
       "name" : "test_hook_1",
       "owner" : "testAdmin1",
       "id" : 5183, ... }, ...

]

Example usages

OrderBy service name example

The following is a sample request URL for the WebhHooks resource that demonstrates how to order the list of webhooks by service name:

Use dark colors for code blocksCopy
https://myserver.domain.com/myTenant/ArcGIS/rest/admin/WebHooks?orderBy=serviceName&f=pjson

The example URL below demonstrates how to search the list of webhooks using the webhook owner's username:

Use dark colors for code blocksCopy
https://myserver.domain.com/myTenant/ArcGIS/rest/admin/WebHooks?user=testAdmin1&f=pjson

JSON Response example

The example response below is ordered by service name:

Use dark colors for code blocksCopy
[
     {
       "name" : "test_hook_1",
       "owner" : "testAdmin1",
       "id" : 5183, ... },

    {
       "name" : "test_hook_2",
       "owner" : "testAdmin2",
       "id" : 5183, ... }, ...
]

The example response below is a list of webhooks owned by a specific user:

Use dark colors for code blocksCopy
[
   {
       "name" : "test_hook_1",
       "owner" : "testAdmin1",
       "id" : 5183, ... },

    {
       "name" : "test_hook_1",
       "owner" : "testAdmin1",
       "id" : 5183, ... }, ...
]