WebhooksGet webhook

Get webhook

Returns a single webhook by ID.

curl -X GET "https://api.sendkit.ai/v1/webhooks/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "_id": "664a1b2c3d4e5f6a7b8c9d0e",
    "workspaceId": "ws_123",
    "name": "CRM Sync",
    "url": "https://crm.example.com/webhooks/sendkit",
    "events": [
      "email.replied",
      "email.positive_reply"
    ],
    "secret": "a1b2c3d4e5f6...",
    "retryAttempts": 3,
    "timeoutMs": 10000,
    "status": "active",
    "createdBy": "user_123",
    "createdAt": "2024-06-01T10:00:00.000Z",
    "updatedAt": "2024-06-01T10:00:00.000Z"
  }
}
GET
/v1/webhooks/{webhookId}
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
path
webhookIdstring
Required

Webhook subscription ID

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

webhookIdstring
Required

Webhook subscription ID

Responses

successboolean
dataobject