Skip to main content
POST
/
projects
/
{projectIdOrName}
/
destinations
Create a new destination
curl --request POST \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data @- <<EOF
{
  "name": "leadConvertedWebhook",
  "type": "webhook",
  "metadata": {
    "url": "https://webhooks.mailmonkey.com/salesforce-lead-converted",
    "headers": {
      "Authorization": "Bearer 1234"
    },
    "region": "us-east-1",
    "streamName": "my-kinesis-stream",
    "endpointUrl": "https://kinesis.us-east-1.amazonaws.com",
    "partitionKeyTemplate": "data.user_id",
    "bucket": "ampersand-integration-bucket",
    "keyTemplate": "join('/', [metadata.objectName, metadata.operationId])",
    "storageClass": "STANDARD"
  },
  "secrets": {
    "awsKeyId": "AKIAIOSFODNN7EXAMPLE",
    "awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy..."
  }
}
EOF
import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations"

payload = {
    "name": "leadConvertedWebhook",
    "type": "webhook",
    "metadata": {
        "url": "https://webhooks.mailmonkey.com/salesforce-lead-converted",
        "headers": { "Authorization": "Bearer 1234" },
        "region": "us-east-1",
        "streamName": "my-kinesis-stream",
        "endpointUrl": "https://kinesis.us-east-1.amazonaws.com",
        "partitionKeyTemplate": "data.user_id",
        "bucket": "ampersand-integration-bucket",
        "keyTemplate": "join('/', [metadata.objectName, metadata.operationId])",
        "storageClass": "STANDARD"
    },
    "secrets": {
        "awsKeyId": "AKIAIOSFODNN7EXAMPLE",
        "awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy..."
    }
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'leadConvertedWebhook',
    type: 'webhook',
    metadata: {
      url: 'https://webhooks.mailmonkey.com/salesforce-lead-converted',
      headers: {Authorization: 'Bearer 1234'},
      region: 'us-east-1',
      streamName: 'my-kinesis-stream',
      endpointUrl: 'https://kinesis.us-east-1.amazonaws.com',
      partitionKeyTemplate: 'data.user_id',
      bucket: 'ampersand-integration-bucket',
      keyTemplate: 'join(\'/\', [metadata.objectName, metadata.operationId])',
      storageClass: 'STANDARD'
    },
    secrets: {
      awsKeyId: 'AKIAIOSFODNN7EXAMPLE',
      awsSecretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
      awsSessionToken: 'AQoEXAMPLEH4aoAH0gNCAPy...'
    }
  })
};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'leadConvertedWebhook',
    'type' => 'webhook',
    'metadata' => [
        'url' => 'https://webhooks.mailmonkey.com/salesforce-lead-converted',
        'headers' => [
                'Authorization' => 'Bearer 1234'
        ],
        'region' => 'us-east-1',
        'streamName' => 'my-kinesis-stream',
        'endpointUrl' => 'https://kinesis.us-east-1.amazonaws.com',
        'partitionKeyTemplate' => 'data.user_id',
        'bucket' => 'ampersand-integration-bucket',
        'keyTemplate' => 'join(\'/\', [metadata.objectName, metadata.operationId])',
        'storageClass' => 'STANDARD'
    ],
    'secrets' => [
        'awsKeyId' => 'AKIAIOSFODNN7EXAMPLE',
        'awsSecretKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
        'awsSessionToken' => 'AQoEXAMPLEH4aoAH0gNCAPy...'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations"

	payload := strings.NewReader("{\n  \"name\": \"leadConvertedWebhook\",\n  \"type\": \"webhook\",\n  \"metadata\": {\n    \"url\": \"https://webhooks.mailmonkey.com/salesforce-lead-converted\",\n    \"headers\": {\n      \"Authorization\": \"Bearer 1234\"\n    },\n    \"region\": \"us-east-1\",\n    \"streamName\": \"my-kinesis-stream\",\n    \"endpointUrl\": \"https://kinesis.us-east-1.amazonaws.com\",\n    \"partitionKeyTemplate\": \"data.user_id\",\n    \"bucket\": \"ampersand-integration-bucket\",\n    \"keyTemplate\": \"join('/', [metadata.objectName, metadata.operationId])\",\n    \"storageClass\": \"STANDARD\"\n  },\n  \"secrets\": {\n    \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n    \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n    \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\"\n  }\n}")

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

	req.Header.Add("X-Api-Key", "<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(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"leadConvertedWebhook\",\n  \"type\": \"webhook\",\n  \"metadata\": {\n    \"url\": \"https://webhooks.mailmonkey.com/salesforce-lead-converted\",\n    \"headers\": {\n      \"Authorization\": \"Bearer 1234\"\n    },\n    \"region\": \"us-east-1\",\n    \"streamName\": \"my-kinesis-stream\",\n    \"endpointUrl\": \"https://kinesis.us-east-1.amazonaws.com\",\n    \"partitionKeyTemplate\": \"data.user_id\",\n    \"bucket\": \"ampersand-integration-bucket\",\n    \"keyTemplate\": \"join('/', [metadata.objectName, metadata.operationId])\",\n    \"storageClass\": \"STANDARD\"\n  },\n  \"secrets\": {\n    \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n    \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n    \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/destinations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"leadConvertedWebhook\",\n  \"type\": \"webhook\",\n  \"metadata\": {\n    \"url\": \"https://webhooks.mailmonkey.com/salesforce-lead-converted\",\n    \"headers\": {\n      \"Authorization\": \"Bearer 1234\"\n    },\n    \"region\": \"us-east-1\",\n    \"streamName\": \"my-kinesis-stream\",\n    \"endpointUrl\": \"https://kinesis.us-east-1.amazonaws.com\",\n    \"partitionKeyTemplate\": \"data.user_id\",\n    \"bucket\": \"ampersand-integration-bucket\",\n    \"keyTemplate\": \"join('/', [metadata.objectName, metadata.operationId])\",\n    \"storageClass\": \"STANDARD\"\n  },\n  \"secrets\": {\n    \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n    \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n    \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "leadConvertedWebhook",
  "type": "webhook",
  "metadata": {
    "url": "https://webhooks.mailmonkey.com/salesforce-lead-converted",
    "headers": {
      "Authorization": "Bearer 1234"
    },
    "streamName": "my-data-stream",
    "region": "us-east-1",
    "partitionKeyTemplate": "{{.integration_id}}",
    "bucket": "ampersand-integration-bucket",
    "keyTemplate": "join('/', [metadata.objectName, metadata.operationId])",
    "storageClass": "STANDARD"
  },
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}
{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}
{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}
{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

Body

application/json
​
name
string
required

Name for the new destination. Must be unique within the project and can only contain letters, numbers and dashes.

Example:

"leadConvertedWebhook"

​
type
enum<string>
required

The type of the destination.

Available options:
webhook,
kinesis,
s3
Example:

"webhook"

​
metadata
object
required
​
secrets
object

Secrets for the destination.

Response

Created

​
id
string
required

The destination ID.

​
name
string
required

User-defined name for the destination.

Example:

"leadConvertedWebhook"

​
type
string
required

The type of the destination.

Example:

"webhook"

​
metadata
object
required
​
createTime
string<date-time>
required

The time the destination was created.

​
updateTime
string<date-time>

The time the destination was updated.