Skip to content

Unsubscribe a webhook​

DELETE
/webhooks/{id}/

Deletes the webhook subscription created by Subscribe. Deleting an id that's already gone, or that belongs to another workspace, is a no-op 204 — not an error. Detach is safe to call more than once.

Playground: fill the path variable id with the integer returned by POST /webhooks/subscribe (field id in the JSON body). Leave it empty and the client will call the literal path /webhooks/{id}/, which returns Django's HTML 404 — that is not a missing subscription.

Authorizations​

ApiKeyAuth

Personal API key. Code samples use Authorization: Bearer <token> — replace <token> with your key from Settings → API Keys (include the word Bearer).

Type
HTTP (bearer)
or
oauth2

OAuth2 access token from the consent flow third-party apps go through (see /oauth/authorize/). Interchangeable with a personal API key on every operation below — both are sent as a Bearer token in the same header.

authorizationCode Flow
Authorization URL"/oauth/authorize/"
Token URL"/oauth/token/"
Scopes:
  • "campaigns:read"List your call campaigns
  • "campaigns:write"Create new call campaigns
  • "contacts:write"Create contacts and queue calls into your campaigns

Parameters​

Path Parameters

id*

Subscription id from Subscribe (POST /webhooks/subscribe response id). Example: 1. Must be a number — do not leave this blank in Try it.

Type
integer
Required

Responses​

Deleted, or already gone — always 204.

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

You need a real subscription id

  1. Open Subscribe and Try it (url: any HTTPS URL, e.g. https://example.com/hooks/test).
  2. Copy the number in the response body field id.
  3. Come back here, put that number in the path variable id (required), then Try it.

Leaving id empty sends the literal path /webhooks/{id}/ and Django returns an HTML 404 — that means the placeholder was not replaced, not that auth failed.