Callback Destinations

Represents callbacks that you have uploaded to Metorial. Callbacks can be linked to various resources based on their purpose. Metorial can also automatically extract callbacks for you, for example for data exports.

Callback Destinations object

Attributes

object

String

Type of the object, fixed as callback.destination

id

String

The unique identifier of the callback destination

type

Enum

The type of the callback destination

name

String

The name of the callback destination

description

String

The description of the callback destination

webhook_destination

ObjectNullable

Details of the webhook callback destination, if applicable

callbacks

Object

Information about the callbacks associated with this destination

created_at

Date

Timestamp when the callback destination was created

{
  "object": "callback.destination",
  "type": "webhook",
  "webhook_destination": {},
  "callbacks": {
    "type": "all"
  }
}

List callback destinations

Returns a paginated list of callback destinations for a specific callback.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

callback_id

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

Get callback destination by ID

Retrieves details for a specific callback by its ID.

URL Parameters

destination_id

String

The unique identifier for the destination

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

Create callback destination

Creates a new callback destination for the instance.

Request Body

name

String

description

StringOptional

url

String

callbacks

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

Update callback destination

Updates an existing callback destination for the instance.

URL Parameters

destination_id

String

The unique identifier for the destination

Request Body

name

StringOptional

description

StringOptionalNullable
PATCHhttp://api.metorial.com/callbacks-destinations/:destination_id
curl -X PATCH "https://api.metorial.com/callbacks-destinations/des_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Delete callback destination

Deletes an existing callback destination for the instance.

URL Parameters

destination_id

String

The unique identifier for the destination

DELETEhttp://api.metorial.com/callbacks-destinations/:destination_id
curl -X DELETE "https://api.metorial.com/callbacks-destinations/des_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."