Skip to the content

Delete an event filter

DELETE /v1/event-filters/{filter_id}

Property	Value
Operation	`delete_event_filter`
Group	Events
Scope	`webhooks:write`
Route class	`control`
Idempotency	No `Idempotency-Key`
Audit	Audited `webhooks.event_filter.delete` (mutation)
Released in	1.52.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Deletes the filter at the revision If-Match names (1.52.0). A filter a Webhook subscription references is refused with 409 event_filter_in_use; an open stream connection that named it keeps the values it read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X DELETE "$VOCAL_API/v1/event-filters/evf_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

const response = await fetch(`${process.env.VOCAL_API}/v1/event-filters/evf_...`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.delete(
    f"{os.environ['VOCAL_API']}/v1/event-filters/evf_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`filter_id`	path	EventFilterId	yes	The id of an event filter: `evf_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`if-match`	header	string	yes	The revision the change was made against, quoted as the ETag returns it, or `*` to overwrite.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	EventFilterDeletion
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`event_filter_in_use`
`412`	`application/json`	ErrorEnvelope	`revision_mismatch`
`428`	`application/json`	ErrorEnvelope	`precondition_required`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is EventFilterDeletion.

Field	Type	Required	Description
`deleted_at`	Timestamp	yes
`id`	EventFilterId	yes
`object`	`"event_filter_deletion"`	yes