Webhook Receivers | ArcGIS REST APIs

URL:: https://<root>/notebooks/webhookReceivers
Methods:: GET
Operations:: Create
Child Resources:: Webhook Receiver
Version Introduced:: 11.4

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and infrastructure Servers

To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The webhookReceivers resource provides a comprehensive list of all service webhook receivers registered with ArcGIS Notebook services. 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://organization.example.com/<context>/admin/notebooks/webhookReceivers?f=pjson

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`

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/notebooks/webhookReceivers?f=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>",
        "message": "",
        "parameters": "JSON parameters to be injected into the notebook.",
        "url": "<URL for sending request to the webhook receiver>",
        "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>",
        "message": "",
        "parameters": "JSON parameters to be injected into the notebook.",
        "url": "<URL for sending request to the webhook receiver>",
        "username": "<username/owner of this webhook receiver>"
    }
]}

JSON Response example

Use dark colors for code blocksCopy
{
  "webhookReceivers": [
    {
      "itemId": "fd205b7de00e4910a465179ff9085858",
      "signatureHeaders": "x-esrihook-signature",
      "name": "check_licenses",
      "disabled": false,
      "id": "9b359042-7383-465c-a971-694c31d44a25",
      "message": "",
      "parameters": "{}",
      "url": "https://mymachine.esri.com/notebooks/rest/events/webhooks/9b359042-7383-465c-a971-694c31d44a25",
      "username": "admin"
    },
    {
      "itemId": "3ecb671bc11945ed964130c4160c4ea6",
      "signatureHeaders": "x-esrihook-signature",
      "apiToken": "",
      "name": "audit_org_members",
      "disabled": false,
      "id": "212e9839-3cb8-4666-a312-073b00e59f7f",
      "message": "",
      "parameters": "{}",
      "url": "https://mymachine.esri.com/notebooks/rest/events/webhooks/212e9839-3cb8-4666-a312-073b00e59f7f",
      "username": "admin"
    }
  ]}