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.
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 generate 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.
Description
The webhook resource provides detailed information about a specific webhook receiver, identified by its ID. Administrators can utilize this resource to obtain essential details, including the signature header and secret key associated with the webhook receiver. Furthermore, this resource allows for various operations, such as the validation, updating, and deleting of a webhook receiver.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default is Values: |
Example usage
The following is a sample request URL used to access an individual webhook receiver resource:
https://organization.example.com/<context>/admin/notebooks/webhookReceivers/<webhook_receiver_id>JSON Response syntax
{
"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.",
"username": "<username/owner of this webhook receiver>",
"url": "<URL for sending request to the webhook receiver>"
}JSON Response example
{
"itemId": "fd205b7de00e4910a465179ff9085858",
"signatureHeaders": "x-esrihook-signature",
"name": "get_server_license",
"disabled": false,
"id": "9b359042-7383-465c-a971-694c31d44a25",
"message": "",
"parameters": "{}",
"username": "admin",
"url": "https://mymachine.esri.com/notebooks/rest/events/webhooks/9b359042-7383-465c-a971-694c31d44a25"
}