/listServiceWebhooks: List Service Webhooks

URL:: https://[root]/portals/[portalID]/webhooks/listServiceWebhooks
Methods:: POST
Version Introduced:: 11.3

Example usage

The following is a sample ArcGIS Enterprise POST request for the listServiceWebhooks operation:

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/webhooks/listServiceWebhooks HTTP/1.1
Host: machine.domain.complete
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=jSmith&f=pjson

Description

The listServiceWebhooks operation returns a list of every service webhook from all servers federated with the organization. The response includes the configuration information for each webhook, as well as the item ID of the Enterprise portal item that the service is associated with.

Request parameters

Parameter Details

Parameter	Details
`userName` (Optional)	Filters the results of the operation to return the webhooks owned by a specific user. If no value is provided, all webhooks (regardless of ownership) are returned. Example Use dark colors for code blocksCopy `1 userName=jSmith`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

userName

(Optional)

Filters the results of the operation to return the webhooks owned by a specific user. If no value is provided, all webhooks (regardless of ownership) are returned.

Example

Use dark colors for code blocksCopy
userName=jSmith

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

Parameter	Details
`id`	The webhook ID.
`folderName`	The service's root folder name.
`serviceName`	The name of the service the webhook is configured for.
`serviceType`	The service type, either FeatureServer or GPServer.
`name`	The name of the webhook.
`changeType`	The event triggers that will invoke the webhook. Geoprocessing service webhooks do not have any configurable event triggers. Rather, the webhook is triggered when the geoprocessing job is successfully completed, canceled, or fails to complete. For feature service webhoks, this will list the configured event triggers.
`signatureKey`	A user-defined alphanumerical string used by ArcGIS Enterprise and the webhook receiver to ensure the authenticity of outogoing webhook requests.
`hookUrl`	The payload URL.
`active`	Indicates if callbacks are enabled (`true`) or disabled (`false`). Values: `true` \| `false`
`contentType`	The media type. Values: `application/json` \| `application/x-www-form-urlencoded`
`scheduleInfo`	Returned only for feature service webhooks. Shows the window for cataloging event triggers for a feature service.
`payloadFormat`	The response payload format. Values: `json` \| `pjson`
`createdTime`	Represents (in Unix time) when the webhook was created.
`lastUpdatedTime`	Represents (in Unix time) when the webhook was last modified. If the webhook was just created, this will return the same time information as `created`.
`owner`	The username of the webhook owner.
`modifiedId`	The username of the member to last modify the webhook.
`itemId`	The portal item ID of the item associated with the service.

JSON Response example

The response below shows two webhooks being returned, one feature service webhook and one geoprocessing service webhook:

Use dark colors for code blocksCopy
{
  "webhooks": [
    {
      "id": "6a02f41b-693d-4d2b-b313-13cc5a143629",
      "folderName": "/",
      "serviceName": "UtilityService",
      "serviceType": "FeatureServer",
      "name": "Utility Post Webhook",
      "changeTypes": ["FeaturesPosted"],
      "signatureKey": "",
      "hookUrl": "https://app.logic.azure.com:443/workflows/dffb2e0433d245a3997e9d65a12f6ad2/triggers/manual/paths/invoke",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1655307786699,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "payloadFormat": "json",
      "createdTime": 1708893065984,
      "lastUpdatedTime": 1708893065984,
      "owner": "admin",
      "modifiedId": "admin",
      "itemId": "214ae9c785324496b6ba19e904bc0840"
    },
    {
      "id": "f1b628e0-68b6-45d3-9fd9-9d0d9052f89c",
      "folderName": "gpserviceFolder",
      "serviceName": "PerformQA",
      "serviceType": "GPServer",
      "name": "QA Webhook",
      "changeTypes": "["*"]",
      "signatureKey": "",
      "hookUrl": "https://app.logic.azure.com:443/workflows/dffb2e0433d245a3997e9d65a12f6ad2/triggers/manual/paths/invoke",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {},
      "payloadFormat": "json",
      "createdTime": 1708893115388,
      "lastUpdatedTime": 1708893115388,
      "owner": "admin",
      "modifiedId": "admin",
      "itemId": "280a71645b0f4983968cea584b571b0e"
    }
  ]
}