Delete a webhook

Overview

Stop a subscription and free its slot.

Use this when you no longer want events, or before creating a replacement of the same type.

You'll need the subscription id.

Deliveries stop immediately, including any queued retries. The subscription no longer appears in List your webhooks.

Prerequisites

• A Partner bearer token. See Authentication.
• The subscription's id, from List your webhooks.

Base URL

Endpoint

DELETE /api/v1/partner/webhooks/{webhookSubscriptionId}

Authentication

Partner token

• Only partner users can call it; other tokens get 403.
• Only your own partner's subscriptions: any other id, including another partner's, gets 404.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "data": {
    "data": {
      "subscription_id": 3,
      "status": "deleted"
    }
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Not a Partner token

{
  "message": "Only partner-admin users can manage webhook subscriptions.",
  "status": "error",
  "errors": []
}

404 Subscription not found

{
  "message": "Subscription not found.",
  "status": "error",
  "errors": []
}

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/webhooks/3" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'