Callback Destinations

Manage callback webhook destinations.

Callback Destinations object

Attributes

object

String

String representing the object's type

id

String

Unique callback destination identifier

status

Enum

Callback destination lifecycle status

name

String

Display name for the callback destination

description

StringNullable

Optional destination description

metadata

ObjectNullable

Custom key-value pairs for storing additional destination metadata

url

String

Webhook URL that receives callback deliveries

method

String

HTTP method used for webhook delivery

created_at

Date

Timestamp when the callback destination was created

updated_at

Date

Timestamp when the callback destination was last updated

{
  "object": "callback.destination",
  "id": "cld_7dEfGhJkLmNpQrSt",
  "status": "active",
  "name": "Primary Webhook Endpoint",
  "description": "Primary production webhook receiver",
  "metadata": {},
  "url": "https://api.example.com/webhooks/metorial",
  "method": "POST",
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

List callback destinations

Returns a paginated list of callback destinations.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

created_at

ObjectOptional

Filter callback destination creation time by date range

updated_at

ObjectOptional

Filter callback destination last update time by date range

GEThttp://api.metorial.com/callback-destinations
curl -X GET "https://api.metorial.com/callback-destinations" \
  -H "Authorization: Bearer metorial_sk_..."

Get callback destination

Retrieves a specific callback destination.

URL Parameters

callback_destination_id

String

The unique identifier for the callback_destination

GEThttp://api.metorial.com/callback-destinations/:callback_destination_id
curl -X GET "https://api.metorial.com/callback-destinations/cal_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create callback destination

Creates a new callback destination.

Request Body

name

String

Display name for the callback destination

description

StringOptional

Optional callback destination description

metadata

ObjectOptional

Custom key-value pairs for storing destination metadata

url

String

Webhook URL that should receive callback deliveries

POSThttp://api.metorial.com/callback-destinations
curl -X POST "https://api.metorial.com/callback-destinations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "url": "example_url"
}'

Update callback destination

Updates a callback destination.

URL Parameters

callback_destination_id

String

The unique identifier for the callback_destination

Request Body

name

StringOptional

Updated callback destination name

description

StringOptional

Updated destination description

metadata

ObjectOptional

Updated destination metadata

url

StringOptional

Updated webhook URL for callback deliveries

PATCHhttp://api.metorial.com/callback-destinations/:callback_destination_id
curl -X PATCH "https://api.metorial.com/callback-destinations/cal_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "url": "example_url"
}'

Delete callback destination

Archives a callback destination.

URL Parameters

callback_destination_id

String

The unique identifier for the callback_destination

DELETEhttp://api.metorial.com/callback-destinations/:callback_destination_id
curl -X DELETE "https://api.metorial.com/callback-destinations/cal_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."