Delete a webhook subscription

Your Company APIWebhook subscriptions

DELETEhttps://api.your-company.example/v1/webhook-subscriptions/{subscription_id}

AuthenticationRequires bearerAuth.

Description

Permanently stops delivery to a webhook subscription.

Request

curl -X DELETE "https://api.your-company.example/v1/webhook-subscriptions/whs_01JAZ92C4Q" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.your-company.example/v1/webhook-subscriptions/whs_01JAZ92C4Q", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
  },
});

import requests

response = requests.delete(
    "https://api.your-company.example/v1/webhook-subscriptions/whs_01JAZ92C4Q",
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response204JSON

No response body.

Parameters

subscription_idpathstringrequired

Webhook subscription identifier.

Responses

204The subscription was deleted. No response body is returned.

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Provide a valid bearer API key.",
    "request_id": "req_01JAZA0P8M"
  }
}

403The API key does not have permission for this action.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required permission.",
    "request_id": "req_01JAZA0P8M"
  }
}

404The resource was not found in the authenticated Workspace.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "request_id": "req_01JAZA0P8M"
  }
}