Update (Webhook Receiver)

URL:: https://<root>/notebooks/webhookReceivers/<webhook receiver id>/update
Methods:: POST
Required Capability:: Administrator
Version Introduced:: 11.4

Description

The update operation enables administrators to modify an existing service webhook receiver registered with ArcGIS Notebook services. Through this operation, various properties of the webhook receiver can be updated, including the name, notebook item ID, secret key, signature header, notebook parameters, and API token. Additionally, this operation allows for enabling or disabling the webhook receiver as needed.

Request parameters

Parameter	Details
`name` (Required)	The name of the webhook receiver (string).
`itemId` (Required)	The portal item ID of the notebook you want to execute using webhook receiver.
`secret` `(Required)`	A secret key used to encrypt webhook payload. It has to be 32 characters long.
`signatureHeaders` (Required)	A comma separated list of headers which will be checked for encrypted payload. Example Use dark colors for code blocksCopy `1 2 signatureHeaders=x-esrihook-signature, x-hub-signature-256`
`apiToken`	The app token with privileges to access the notebook item, the `createNotebook` or `createAdvancedNotebook` privileges, and any other GIS capabilities in the notebook.
`disabled`	A boolean value to enable or disable the webhook receiver Values: `true` \| `false`
`parameters`	Parameter json to be injected directly into the notebook as input parameters.
`f`	The response format. The default is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
POST /<context>/admin/notebooks/webhookReceivers/update

Host: organization.example.com

Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]

name=demo&itemId=923dc118f035463f84d90660909cef50&secret=demodemodemodemodemodemodemodemo&signatureHeaders=x-esrihook-signature,x-hub-signature-256&apiToken=&disabled=true&parameters={"num":1,"name":"esri","loop":false}&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "webhookReceiver": {
        "itemId": <item_id>,
        "signatureHeaders": <comma separated list of headers>,
        "apiToken": "",
        "name": <webhook receiver name>,
        "disabled": true|false,
        "id": <webhook_receiver_id>,
        "secret": <secret_key>,
        "username": <user_name>,
        "url": "<URL for sending request to the webhook receiver>"
    },
    "status": "success"
}

JSON Response example

Use dark colors for code blocksCopy
{
    "webhookReceiver": {
        "itemId": "e045a267621441f5a27ddd36e94890aa",
        "signatureHeaders": "x-esrihook-signature,x-hub-signature-256,
        "apiToken": "",
        "name": "test",
        "disabled": false,
        "id": "b50dec7a-e271-4235-8a04-7785c91eaa6d",
        "secret": "9f8b47c2e4a748d3b58e2a17ad8f2e4b",
        "username": "portaladmin",
        "url": "https://mymachine.esri.com/notebooks/rest/events/webhooks/b50dec7a-e271-4235-8a04-7785c91eaa6d
    },
    "status": "success"
}