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

POST

/api/destinations

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.langparse.dev/api/destinations");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-Api-Key: <X-Api-Key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.langparse.dev/api/destinations"),
    Headers =
    {
        { "X-Api-Key", "<X-Api-Key>" },
    },
    Content = new StringContent("{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.langparse.dev/api/destinations"

  payload := strings.NewReader("{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("X-Api-Key", "<X-Api-Key>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.langparse.dev/api/destinations"))
    .header("X-Api-Key", "<X-Api-Key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }");
Request request = new Request.Builder()
  .url("https://api.langparse.dev/api/destinations")
  .post(body)
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.langparse.dev/api/destinations',
  headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'},
  data: {
    kind: 'webhook',
    name: 'Ops webhook',
    url: 'https://example.com/hook',
    secret: 'whsec_…',
    sourceIds: ['rest-api']
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.langparse.dev/api/destinations';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'},
  body: '{"kind":"webhook","name":"Ops webhook","url":"https://example.com/hook","secret":"whsec_…","sourceIds":["rest-api"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"kind\": \"webhook\", \"name\": \"Ops webhook\", \"url\": \"https://example.com/hook\", \"secret\": \"whsec_…\", \"sourceIds\": [ \"rest-api\" ] }")
val request = Request.Builder()
  .url("https://api.langparse.dev/api/destinations")
  .post(body)
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.langparse.dev/api/destinations";

    let payload = json!({
        "kind": "webhook",
        "name": "Ops webhook",
        "url": "https://example.com/hook",
        "secret": "whsec_…",
        "sourceIds": ("rest-api")
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("X-Api-Key", "<X-Api-Key>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

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": "Ops webhook", "url": "https://example.com/hook", "secret": "whsec_…", "sourceIds": [ "rest-api" ] }'

wget --quiet \
  --method POST \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "kind": "webhook", "name": "Ops webhook", "url": "https://example.com/hook", "secret": "whsec_…", "sourceIds": [ "rest-api" ] }' \
  --output-document \
  - https://api.langparse.dev/api/destinations

Create a destination to deliver parsed results to. Bind it to one or more sourceIds (use rest-api for API-submitted documents), choose the resultShape, and — for S3/SQS/SNS — assume a cross-account role from POST /destinations/policy.

Authorizations

apiKey
bearerAuth

Request Body^required

application/json

object

kind

required

string

Allowed values: webhook s3 sqs sns

name

string

resultShape

string

Allowed values: full data-only

sourceIds

Sources routed here (‘rest-api’ for API-submitted docs).

Array<string>

writeTags

boolean

url

Webhook only

string

secret

Webhook HMAC secret

string

bucket

string

prefix

string

region

string

roleArn

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

string

Example

{
  "kind": "webhook",
  "name": "Ops webhook",
  "url": "https://example.com/hook",
  "secret": "whsec_…",
  "sourceIds": [
    "rest-api"
  ]
}

Responses

200

The created destination.

application/json

object

data

required

A destination (secret redacted to hasSecret). Own key id.

object

key

additional properties

any

Example

{
  "data": {
    "id": "dst_wh01",
    "kind": "webhook",
    "name": "Ops webhook",
    "enabled": true,
    "hasSecret": true
  }
}

401

Missing or invalid API key.

application/json

Error response. statusCode mirrors the HTTP status; statusMessage is human-readable.

object

statusCode

integer

statusMessage

string

Example

{
  "statusCode": 404,
  "statusMessage": "Document not found"
}

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

Authorizations

Request Bodyrequired

Example

Responses

200

Example

401

Example

Request Body^required