POST /webhooks/{id}/enable
Start delivering to a subscription
| Scope | webhooks:write |
| Cost | Free |
POST, not GET: a GET that changes state is cacheable and
prefetchable, so a proxy or a link-preview bot could flip your
subscription.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
id | integer | yes | 2074 | The subscription id. |
Responses
200
The subscription, now enabled.
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
description | string | |
url | string | Where events are delivered. http or https, max 1024 characters. |
type | AccountRealTimeCalls | AccountEndedCalls | UserEndedCalls | AccountSMS | AccountAITranscription | The event a subscription fires on. Fetch the live list from GET /webhooks/types. |
enabled | boolean | Whether events are being delivered. |
createdAt | string (RFC 3339) | |
updatedAt | string (RFC 3339) |
Errors
| Status | Meaning |
|---|---|
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
404 | not_found — no such object, or it is not this account's. The two are deliberately indistinguishable. |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X POST 'https://api.account.telebroad.com/api/public/v1/webhooks/2074/enable' \
-H "Authorization: Bearer $TB_KEY"