Delete a webhook subscription

DELETE
/hooks/subscriptions/{subscriptionId}

Deletes a webhook subscription. Terac stops sending to it at once, including retries already queued, and its past deliveries stay readable in GET /hooks/events.

Authorization

apiKey
Authorization<token>

API key as Bearer token: Authorization: Bearer

In: header

Path Parameters

subscriptionId*string

ID of the webhook subscription, as returned when it was created or listed.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://terac.com/api/external/v2/hooks/subscriptions/string"
{
  "id": "string",
  "deleted": true
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required. Include Authorization: Bearer <key> header."
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This account is not permitted to use the API."
  }
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 61 seconds."
  }
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Confirm a webhook subscription POST

Confirms a webhook subscription by POSTing one signed webhook.ping to its target_url. Answer 2xx and the subscription starts receiving events; any other outcome returns 412 with the reason, and it stays unconfirmed. This is also the way to test a receiver end to end, since it exercises the real signature headers.

Read a subscription's signing secret GET

Returns a subscription's current signing secret, for recovering one you no longer have. Rotate instead if you believe it leaked, since reading it does not invalidate anything.