Skip to main content
PATCH
/
api
/
v1
/
webhooks
/
{webhook_id}
curl -X PATCH "https://api.foxreach.io/api/v1/webhooks/cwh_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["email.sent", "reply.received", "lead.created"],
    "isActive": true
  }'
{
  "data": {
    "id": "cwh_abc123",
    "url": "https://your-app.com/webhooks/outreach",
    "isActive": true,
    "events": ["email.sent", "reply.received", "lead.created"],
    "lastDeliveredAt": "2025-01-15T10:30:00",
    "consecutiveFailures": 0,
    "createdAt": "2025-01-01T10:00:00",
    "updatedAt": "2025-01-16T09:00:00"
  }
}

Path Parameters

webhook_id
string
required
The unique identifier of the webhook.

Request Body

All fields are optional.
url
string
New endpoint URL.
events
array
Updated list of event types to subscribe to.
isActive
boolean
Enable or disable the webhook.
curl -X PATCH "https://api.foxreach.io/api/v1/webhooks/cwh_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["email.sent", "reply.received", "lead.created"],
    "isActive": true
  }'
{
  "data": {
    "id": "cwh_abc123",
    "url": "https://your-app.com/webhooks/outreach",
    "isActive": true,
    "events": ["email.sent", "reply.received", "lead.created"],
    "lastDeliveredAt": "2025-01-15T10:30:00",
    "consecutiveFailures": 0,
    "createdAt": "2025-01-01T10:00:00",
    "updatedAt": "2025-01-16T09:00:00"
  }
}

Errors

StatusDescription
404Webhook not found
422Invalid event types provided

Rate Limit

  • 100 requests per minute, per API key. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).
For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.