Skip to content
Console
On this page

Delete a webhook endpoint

Deletes a webhook endpoint.

Deletes a webhook endpoint.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint
  • Scope events:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection webhook_endpoints
  • Query etag, allow_missing, validate_only, force

Request

FieldTypeWhat it is
namestringThe name of the webhook endpoint to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the webhook endpoint does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso delete the endpoint's delivery records and the Subscriptions that target it.

Response

The call answers with an empty object.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"