Waitlist API reference

Waitlist API · Webhooks

patch/v1/workspaces/{workspace_id}/webhooks/{id}Auth

Update url / events / active flag. `active: true` also clears an automatic switch-off.

Deprecated: use `/v1/workspaces/{workspace_id}/webhooks/endpoints` (event descriptions, Send test that reports the result, event log, replay, rotation with a grace period). Responses carry `Deprecation: true` and `Sunset: Fri, 15 Jan 2027 00:00:00 GMT`.

Path parameters

workspace_id*string · uuid

Id of the workspace.

id*string · uuid

Id of the webhook.

Request body

urlstring

New URL

eventsarray

New event subscription

activeboolean

Pause/resume the webhook

Response · 200 Updated webhook (secret masked).

id*string
workspace_id*string
url*string
events*array

Subscribed events (`event_types` on the new routes).

active*boolean

Whether it receives events (`enabled` on the new routes).

failure_count*number

Failed deliveries in a row (`consecutive_failures` on the new routes).

last_status_code*number

HTTP status of the latest attempt.

last_attempt_at*string

When the latest attempt was made.

auto_disabled_at*string

Set when it was switched off automatically after sustained failures.

first_failure_at*string
created_at*string
secret_setboolean

Always true: every webhook has a signing secret.

Example

Request

PATCH https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/webhooks/{id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "url": "string",
  "events": [
    "entry.created"
  ],
  "active": false
}

Response

{
  "id": "string",
  "workspace_id": "string",
  "url": "string",
  "events": [
    "entry.created"
  ],
  "active": false,
  "failure_count": 0,
  "last_status_code": 0,
  "last_attempt_at": "string",
  "auto_disabled_at": "string",
  "first_failure_at": "string",
  "created_at": "string",
  "secret_set": false
}