Graphon Engine

Delete webhook

Delete a webhook and its delivery log.

DELETE/webhooks/{webhook}

PermissionCluster key, or a scoped key with write on every collection that the webhook covers. Key scopes and actions.

  • Successful deletion returns 204 with no body. Queued events are dropped, the log goes with the webhook, and the name is free at once. A POST already in flight finishes and is not recorded.
  • To stop deliveries and keep the log, update the webhook with enabled: false.
  • A namespace or collection delete never deletes a webhook.

Path parameters

webhookstringrequired

Webhook ID with the whk_ prefix, or the webhook’s name.

Responses

204Webhook deleted

The webhook and its log are gone. This response has no body.

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

This response has no body.

Errors

Select an error in the response example to see its JSON body. See error handling for the common error format.

400invalid_request

A field, path, parameter, or conditional request rule is invalid.

What to do: Correct the request. Unknown fields are rejected.

401unauthenticated

The API key is missing, invalid, or revoked.

What to do: Send an active key in Authorization: Bearer or X-API-Key.

403forbidden

The key can see the resource but lacks permission for this operation.

What to do: Use a key with the required action or scope kind.

404not_found

The resource is absent, deleted, or outside this key’s scope.

What to do: Check the identifier and the key’s namespace and collection scope.

503temporarily_unavailable

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

500internal_error

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?
View as Markdown