- URL:
- https://<root>/notebooks/webhookReceivers/<webhook_receiver_id>
- Methods:
GET- Required Capability:
- Administrator
- Version Introduced:
- 11.4
Description
The service webhook receiver 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: |
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>",
"secret": "A 32 character alpha numeric string",
"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",
"secret": "Secret_to_be_sent_to_webhook_receiver",
"message": "",
"parameters": "{}",
"username": "admin",
"url": "https://mymachine.esri.com/notebooks/rest/events/webhooks/9b359042-7383-465c-a971-694c31d44a25"
}