logo
WebhooksList webhooks
Webhooks

List webhooks

Returns a paginated list of webhooks configured for the workspace.

curl -X GET "https://api.sendkit.ai/v1/webhooks?page=25&limit=42&cursor=example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": [
    {
      "_id": "664a1b2c3d4e5f6a7b8c9d0e",
      "workspaceId": "ws_123",
      "name": "CRM Sync",
      "url": "https://crm.example.com/webhooks/sendkit",
      "events": [
        "email.replied",
        "email.positive_reply",
        "lead.updated"
      ],
      "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"
    }
  ],
  "pagination": {
    "total": 3,
    "page": 1,
    "limit": 20,
    "pages": 1
  }
}
GET
/v1/webhooks
GET
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_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
query
limitinteger
Min: 1 • Max: 100
query
cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

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_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Query Parameters

cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

Responses

successboolean
dataarray
paginationobject