DocsAPI ReferenceWebhooks

Webhooks

Webhooks let you receive real-time notifications when events happen in your workspace.

Setting Up

Register a webhook endpoint in the dashboard or via the API:

curl -X POST https://api.clawployees.com/v1/webhooks \
  -H "Authorization: Bearer sk_live_..." \
  -d '{
    "url": "https://your-app.com/webhooks/clawployees",
    "events": ["conversation.created", "conversation.escalated"]
  }'

Events

EventDescription
`conversation.created`New conversation started
`conversation.message`New message in a conversation
`conversation.escalated`Agent escalated to human
`conversation.resolved`Conversation marked resolved
`agent.deployed`Agent was deployed
`agent.error`Agent encountered an error

Payload Format

{
  "id": "evt_abc123",
  "type": "conversation.created",
  "created_at": "2026-01-15T10:30:00Z",
  "data": {
    "conversation_id": "conv_xyz",
    "agent_id": "agt_456",
    "platform": "slack",
    "channel": "#support"
  }
}

Verification

Verify webhook signatures using the X-Clawployees-Signature header:

import { verifyWebhook } from '@clawployees/sdk';

const isValid = verifyWebhook(payload, signature, secret);

Retry Policy

Failed deliveries are retried up to 5 times with exponential backoff (1min, 5min, 30min, 2hr, 12hr).

PreviousREST APINextSDKs