Create a new webhook

POST

/v1/webhooks

Creates a new webhook that will receive notifications when searches complete.

Enterprise only. This endpoint is exclusive to enterprise clients and returns organization-level
information (e.g. organizationId). Not available to individual or non-enterprise users.

Requirements

Webhook URL must use HTTPS.

Secret is used to generate HMAC signatures for webhook payloads (minimum 16 characters).

Supported platforms

Slack (Block Kit)

Microsoft Teams (Adaptive Cards)

Zapier (flat JSON)

n8n (flat JSON)

Make (flat JSON)

Power Automate (flat JSON)

Custom (raw JSON via platform: custom)

The platform is auto-detected from the URL when possible. Set platform explicitly to force a format.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Webhook successfully created.

Body

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sherlockeye.io/v1/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://example.com/webhooks/sherlockeye",
    "secret": "your-secret-key-minimum-16-chars",
    "events": [
        "search.completed",
        "watchlist.alert"
    ]
}'

Response Example

201 - 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

List all webhooks for the authenticated user