Skip to content

Update webhook

Update an existing webhook configuration. All fields except _id are optional; only provided fields will be updated.

When provided, name must be 1-50 characters, url must be a valid URL, and events must contain at least one event. Whitespace is trimmed from url before validation.

Webhooks are automatically disabled after 10 consecutive delivery failures.

PUT /v1/webhooks/settings

Update an existing webhook configuration. All fields except _id are optional; only provided fields will be updated.

When provided, name must be 1-50 characters, url must be a valid URL, and events must contain at least one event. Whitespace is trimmed from url before validation.

Webhooks are automatically disabled after 10 consecutive delivery failures.

Request body

Content-Type: application/json

  • _id (string) required — Webhook ID to update (required)
  • name (string) — Webhook name (1-50 characters). Must be non-empty if provided.
  • url (string) — Webhook endpoint URL (must be a valid URL, whitespace trimmed). Must be a valid URL if provided.
  • secret (string) — Secret key for HMAC-SHA256 signature verification
  • events (array) — Events to subscribe to. Must contain at least one event if provided.
  • isActive (boolean) — Enable or disable webhook delivery
  • customHeaders (object) — Custom headers to include in webhook requests

Responses

200 — Webhook updated successfully

  • success (boolean)
  • webhook ($ref)

400 — Validation error or missing webhook ID

401

404 — Webhook not found