Create a destination (webhook / S3 / SQS / SNS)

POST

/api/destinations

curl --request POST \
  --url https://api.langparse.dev/api/destinations \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --data '{ "kind": "webhook", "name": "example", "resultShape": "full", "sourceIds": [ "example" ], "writeTags": true, "url": "example", "secret": "example", "bucket": "example", "prefix": "example", "region": "example", "roleArn": "example" }'

Authorizations

• apiKey
• bearerAuth

Request Body^required

Media typeapplication/json

object

kind

required

string

Allowed values: webhook s3 sqs sns

name

string

resultShape

string

Allowed values: full data-only

sourceIds

Sources routed to this destination (‘rest-api’ for API-submitted docs).

Array<string>

writeTags

Attach output tags + metadata to delivered S3 objects.

boolean

url

Webhook only

string

secret

Webhook HMAC secret

string

bucket

string

prefix

string

region

string

roleArn

S3/SQS/SNS — role created from /destinations/policy.

string

Responses

200

Created destination

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}