Get a webhook endpoint

GET

webhook_endpoints

{id}

curl --request GET \
  --url https://api.callingbox.io/v1/webhook_endpoints/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "description": "<string>",
  "enabled_events": [
    "<string>"
  ],
  "disabled_reason": "<string>",
  "disabled_at": "2023-11-07T05:31:56Z",
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

default:sk_live_your_api_key

required

API key starting with sk_

Path Parameters

string<uuid>

required

Response

Endpoint

string<uuid>

org_id

string<uuid>

url

string

description

string | null

enabled_events

string[]

status

enum<string>

Available options:

enabled,

disabled

disabled_reason

string | null

Populated when CallingBox auto-disables the endpoint after 10 consecutive exhausted deliveries (too_many_failures) or when manually disabled.

disabled_at

string<date-time> | null

consecutive_failures

integer

Consecutive exhausted deliveries. Resets on success.

created_at

string<date-time>

updated_at

string<date-time>

Create a webhook endpoint

Update a webhook endpoint

⌘I

Get a webhook endpoint

curl --request GET \
  --url https://api.callingbox.io/v1/webhook_endpoints/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "description": "<string>",
  "enabled_events": [
    "<string>"
  ],
  "disabled_reason": "<string>",
  "disabled_at": "2023-11-07T05:31:56Z",
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}