Skip to navigation

Delete a webhook

View as Markdown

Deletes the endpoint. It stops receiving events immediately: pending deliveries are canceled (last_error: endpoint_deleted) and nothing further is sent. The endpoint is removed from GET /api/webhooks and its delivery log can no longer be listed. Deletion cannot be undone; a replacement endpoint receives a new secret.

Side effects. Marks the endpoint deleted and inactive and cancels its pending deliveries. Written to the audit log.

Idempotency. Safe to retry. A repeated call returns 404, which can be treated as success.

Webhook events. Emits audit.log_recorded to endpoints subscribed to it. See Webhooks.

Access

  • Required scope: full. Human users need the owner or admin role.
  • Rate limit: General API (120–600 requests/min per workspace, by plan) plus the configuration-mutations limit — 10 requests/min per workspace, shared with other configuration changes. See Rate limits.
  • Plan: Available on every plan and also without an active subscription, so a workspace can still remove its webhooks. See Billing and usage.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

webhookIdstringRequiredformat: "uuid"

UUID of the outbound webhook endpoint, returned as id by GET /api/webhooks. It must belong to the authenticated workspace; an id from another workspace, an unknown id or a value that is not a UUID answers 404.

Response

Deleted. No body.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error