Update a webhook

PUT

/v1/webhooks/{webhookId}

Updates webhook configuration. You can change the URL, events, or enable/disable the webhook.
The secret cannot be updated; create a new webhook if you need to change it.
Enterprise only. This endpoint is exclusive to enterprise clients; responses include organization-level information (e.g. organizationId).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Webhook successfully updated.

Body

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.sherlockeye.io/v1/webhooks/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "events": [
        "search.completed"
    ],
    "enabled": true,
    "platform": "slack",
    "formatting": "rich"
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "id": "string",
        "userId": "string",
        "organizationId": "string",
        "url": "http://example.com",
        "events": [
            "search.completed"
        ],
        "enabled": true,
        "platform": "slack",
        "formatting": "rich",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "lastDelivery": {
            "status": "success",
            "timestamp": "2019-08-24T14:15:22.123Z"
        }
    }
}

Modified at 2026-03-04 16:42:25

Get webhook details

Delete a webhook