VocalDocscontracts 1.65.0

Delete a Webhook subscription

DELETE /v1/webhooks/{webhook_id}

PropertyValue
Operationdelete_webhook
GroupWebhooks
Scopewebhooks:write
Route classcontrol
IdempotencyNo Idempotency-Key
AuditAudited webhooks.subscription.delete (mutation)
Released in1.63.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Deletes the subscription at the revision If-Match names (1.63.0): its pending deliveries stop, and its delivery log goes with it.

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/webhooks/whk_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

Parameters

NameInTypeRequiredDescription
webhook_idpathWebhookIdyesThe id of a Webhook subscription: whk_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.

Responses

StatusContent typeShapeError codes
200application/jsonWebhookSubscriptionDeletion
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden, org_suspended
404application/jsonErrorEnvelopenot_found
412application/jsonErrorEnveloperevision_mismatch
428application/jsonErrorEnvelopeprecondition_required
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is WebhookSubscriptionDeletion.

FieldTypeRequiredDescription
deleted_atTimestampyes
idWebhookIdyes
object"webhook_subscription_deletion"yes