logo
WebhooksList webhooks

List webhooks

Returns a paginated list of webhooks configured for the workspace.

curl -X GET "https://api.sendkit.ai/v1/webhooks?cursor=664a1b2c3d4e5f6a7b8c9d0e&limit=42" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": [
    {
      "_id": "664a1b2c3d4e5f6a7b8c9d0e",
      "workspaceId": "ws_123",
      "name": "Analytics Pipeline",
      "url": "https://analytics.internal.example.com/ingest",
      "events": [
        "email.sent",
        "email.opened",
        "email.clicked",
        "email.replied",
        "email.bounced",
        "email.unsubscribed"
      ],
      "status": "inactive",
      "secret": "whsec_test_53668aa2-e9dc-45",
      "retryAttempts": 2,
      "timeoutMs": 5000,
      "stats": {
        "totalDelivered": 2444,
        "totalFailed": 79,
        "lastDeliveredAt": "2026-01-27T04:49:34.111Z"
      },
      "createdBy": "user_123",
      "createdAt": "2026-01-30T11:30:46.006Z",
      "updatedAt": "2026-01-19T04:56:19.760Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "total": 3,
    "hasMore": false,
    "nextCursor": "664a1b2c3d4e5f6a7b8c9d0e"
  }
}
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_...)
query
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

query
limitinteger

Items per page (default 25, max 100)

Min: 1 • Max: 100
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_...)

Query Parameters

cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

limitinteger

Items per page (default 25, max 100)

Responses

successboolean
dataarray
paginationobject