Webhook Receivers

URL:: https://<root>/notebooks/webhookReceivers
Methods:: GET
Required Capability:: Administrator
Version Introduced:: 11.4

Description

The webhookReceiver resource provides a comprehensive list of all service webhook receivers registered with ArcGIS Notebook Server. Webhooks, including those for asynchronous geoprocessing services, feature services, or any generic webhook, can initiate a notebook run in response to specific events. This is accomplished by sending a request to the webhook receiver URL:

Use dark colors for code blocksCopy
https://<notebookserver.domain.com>/<notebooks_webcontext>/rest/events/webhooks/<webhook_receiver_id>

To ensure security, the webhook event request must include a signature header that was predefined for the webhook receiver. Additionally, it should contain a secret value represented as a Hash Message Authentication Code (HMAC), generated using the SHA-256 hashing function and encoded in Base64 format.

Request parameters

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

JSON Response syntax

Use dark colors for code blocksCopy
{"webhookReceivers": [
    {
        "itemId": "<itemId of notebook that will be run with webhook>",
        "signatureHeaders": "Comma separated list of signature headers such as x-esrihook-signature,X-Hub-Signature-256, other signature headers",
        "name": "<Name of Webhook Receiver 1>",
        "disabled": <a boolean indicating if webhook is enabled or disabled: true|false>,
        "id": "<Id of webhook receiver that is autogenerated at the time of creation>",
        "secret": "A 32 character alpha numeric string",
        "message": "",
        "parameters": "JSON parameters to be injected into the notebook.",
        "username": "<username/owner of this webhook receiver>"
    },
  {
        "itemId": "<itemId of notebook that will be run with webhook>",
        "signatureHeaders": "Comma separated list of signature headers such as x-esrihook-signature,X-Hub-Signature-256, other signature headers",
        "name": "<Name of Webhook Receiver 2>",
        "disabled": <a boolean indicating if webhook is enabled or disabled: true|false>,
        "id": "<Id of webhook receiver that is autogenerated at the time of creation>",
        "secret": "A 32 character alpha numeric string",
        "message": "",
        "parameters": "JSON parameters to be injected into the notebook.",
        "username": "<username/owner of this webhook receiver>"
    },
]}

JSON Response example

Use dark colors for code blocksCopy
{"webhookReceivers": [
    {
        "itemId": "fd205b7de00e4910a465179ff9085858",
        "signatureHeaders": "x-esrihook-signature",
        "name": "get_server_license",
        "disabled": false,
        "id": "9b359042-7383-465c-a971-694c31d44a25",
        "secret": "Secret_to_be_sent_to_webhook_receiver",
        "message": "",
        "parameters": "{}",
        "username": "admin"
    },
    {
        "itemId": "3ecb671bc11945ed964130c4160c4ea6",
        "signatureHeaders": "x-esrihook-signature",
        "apiToken": "",
        "name": "serverlicense",
        "disabled": false,
        "id": "212e9839-3cb8-4666-a312-073b00e59f7f",
        "secret": "Secret2_to_be_sent_to_webhook_receiver",
        "message": "",
        "parameters": "{}",
        "username": "admin"
    }
]}