Webhooks (Services)

• URL:https://<root>/services/webhooks
  
• Operations:Settings
• Required Capability: Default administrator role | Feature layer | Geoprocessing | Publisher role
• Version Introduced:11.2

Description

The webhooks resource returns a list of all service webhooks that are currently configured for the organization, providing a centralized location for users with the appropriate permissions to view and manage service webhooks. This resource also provides access to the Settings operation, which allows administrators to apply advanced settings for webhook notifications and deactivation policies.

Request parameters

Parameter	Details
f	The response format. The default format is html. Values: html | json | pjson

Example usage

The following is a sample request URL used to access the webhooks resource:

https://organization.domain.com/context/admin/services/webhooks?f=pjson

JSON Response example

{
  "webhooks": [
    {
      "id": "5bd49e76-df28-4bb4-91a2-bed823c69818",
      "folderName": "Hosted",
      "serviceName": "fs_webhook_1",
      "serviceType": "FeatureServer",
      "name": "Webhook 3",
      "signatureKey": "12345ABCDEF",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1695754552188,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "payloadFormat": "json",
      "created": 1695754574941,
      "modified": 1695754574941,
      "ownerId": "webhookAdmin",
      "modifiedId": "webhookAdmin",
      "changeTypes": ["*"]
    },
    {
      "id": "72eacbf0-7dc7-4596-88c8-0865f744fdd9",
      "folderName": "Hosted",
      "serviceName": "fs_webhook_2",
      "serviceType": "FeatureServer",
      "name": "Webhook 2",
      "signatureKey": "12345ABCDEF",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1695754525418,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "payloadFormat": "json",
      "created": 1695754539515,
      "modified": 1695754539515,
      "ownerId": "webhookAdmin",
      "modifiedId": "webhookAdmin",
      "changeTypes": [
        "AttachmentsCreated",
        "AttachmentsUpdated"
      ]
    },
    {
      "id": "cc7a09a9-011d-47d7-a3d2-2769b55b0332",
      "folderName": "Hosted",
      "serviceName": "fs_webhook_1",
      "serviceType": "FeatureServer",
      "name": "Webhook 1",
      "signatureKey": "12345ABCDEF",
      "hookUrl": "https://app.logic.azure.com:443/workflows/...",
      "active": true,
      "contentType": "application/json",
      "scheduleInfo": {
        "name": "",
        "state": "enabled",
        "startAt": 1695753963180,
        "recurrenceInfo": {
          "interval": 20,
          "frequency": "second"
        }
      },
      "payloadFormat": "json",
      "created": 1695753968096,
      "modified": 1695753968096,
      "ownerId": "webhookAdmin",
      "modifiedId": "webhookAdmin",
      "changeTypes": [
        "FeaturesDeleted",
        "FeaturesEdited",
        "FeatureServiceDefinitionChanged"
      ]
    }
  ]
}