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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"secrets": {
"awsKeyId": "AKIAIOSFODNN7EXAMPLE",
"awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy...",
"password": "my-clickhouse-password",
"privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----",
"credentials": "{\"type\":\"service_account\", ...}",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"accessKey": "my-azure-access-key",
"uri": "amqp://user:pass@rabbit.example.com:5672"
}
}
EOFimport 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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"secrets": {
"awsKeyId": "AKIAIOSFODNN7EXAMPLE",
"awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy...",
"password": "my-clickhouse-password",
"privateKey": "-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----",
"credentials": "{\"type\":\"service_account\", ...}",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"accessKey": "my-azure-access-key",
"uri": "amqp://user:pass@rabbit.example.com:5672"
}
}
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',
username: 'default',
tableName: 'events',
database: 'analytics',
accountIdentifier: 'myorg-myaccount',
userId: 'SVC_AMPERSAND',
dbName: 'ANALYTICS',
schemaName: 'PUBLIC',
projectId: 'my-gcp-project',
datasetId: 'analytics',
tableId: 'events',
workgroupName: 'my-workgroup',
clusterIdentifier: 'my-cluster',
dbUser: 'ampersand',
account: 'mystorageaccount',
container: 'ampersand-data',
queueUrl: 'https://sqs.us-east-1.amazonaws.com/123456789012/my-queue',
topicArn: 'arn:aws:sns:us-east-1:123456789012:my-topic',
eventBusName: 'default',
detailType: 'ampersand.record',
topicId: 'ampersand-events',
routingKey: 'ampersand.events',
batchSize: 1000,
maxWaitSecs: 30
},
secrets: {
awsKeyId: 'AKIAIOSFODNN7EXAMPLE',
awsSecretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
awsSessionToken: 'AQoEXAMPLEH4aoAH0gNCAPy...',
password: 'my-clickhouse-password',
privateKey: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----',
credentials: '{"type":"service_account", ...}',
accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
accessKey: 'my-azure-access-key',
uri: 'amqp://user:pass@rabbit.example.com:5672'
}
})
};
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',
'username' => 'default',
'tableName' => 'events',
'database' => 'analytics',
'accountIdentifier' => 'myorg-myaccount',
'userId' => 'SVC_AMPERSAND',
'dbName' => 'ANALYTICS',
'schemaName' => 'PUBLIC',
'projectId' => 'my-gcp-project',
'datasetId' => 'analytics',
'tableId' => 'events',
'workgroupName' => 'my-workgroup',
'clusterIdentifier' => 'my-cluster',
'dbUser' => 'ampersand',
'account' => 'mystorageaccount',
'container' => 'ampersand-data',
'queueUrl' => 'https://sqs.us-east-1.amazonaws.com/123456789012/my-queue',
'topicArn' => 'arn:aws:sns:us-east-1:123456789012:my-topic',
'eventBusName' => 'default',
'detailType' => 'ampersand.record',
'topicId' => 'ampersand-events',
'routingKey' => 'ampersand.events',
'batchSize' => 1000,
'maxWaitSecs' => 30
],
'secrets' => [
'awsKeyId' => 'AKIAIOSFODNN7EXAMPLE',
'awsSecretKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
'awsSessionToken' => 'AQoEXAMPLEH4aoAH0gNCAPy...',
'password' => 'my-clickhouse-password',
'privateKey' => '-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----',
'credentials' => '{"type":"service_account", ...}',
'accessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
'secretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
'accessKey' => 'my-azure-access-key',
'uri' => 'amqp://user:pass@rabbit.example.com:5672'
]
]),
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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"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"
}Destination
Create a new destination
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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"secrets": {
"awsKeyId": "AKIAIOSFODNN7EXAMPLE",
"awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy...",
"password": "my-clickhouse-password",
"privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----",
"credentials": "{\"type\":\"service_account\", ...}",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"accessKey": "my-azure-access-key",
"uri": "amqp://user:pass@rabbit.example.com:5672"
}
}
EOFimport 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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"secrets": {
"awsKeyId": "AKIAIOSFODNN7EXAMPLE",
"awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy...",
"password": "my-clickhouse-password",
"privateKey": "-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----",
"credentials": "{\"type\":\"service_account\", ...}",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"accessKey": "my-azure-access-key",
"uri": "amqp://user:pass@rabbit.example.com:5672"
}
}
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',
username: 'default',
tableName: 'events',
database: 'analytics',
accountIdentifier: 'myorg-myaccount',
userId: 'SVC_AMPERSAND',
dbName: 'ANALYTICS',
schemaName: 'PUBLIC',
projectId: 'my-gcp-project',
datasetId: 'analytics',
tableId: 'events',
workgroupName: 'my-workgroup',
clusterIdentifier: 'my-cluster',
dbUser: 'ampersand',
account: 'mystorageaccount',
container: 'ampersand-data',
queueUrl: 'https://sqs.us-east-1.amazonaws.com/123456789012/my-queue',
topicArn: 'arn:aws:sns:us-east-1:123456789012:my-topic',
eventBusName: 'default',
detailType: 'ampersand.record',
topicId: 'ampersand-events',
routingKey: 'ampersand.events',
batchSize: 1000,
maxWaitSecs: 30
},
secrets: {
awsKeyId: 'AKIAIOSFODNN7EXAMPLE',
awsSecretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
awsSessionToken: 'AQoEXAMPLEH4aoAH0gNCAPy...',
password: 'my-clickhouse-password',
privateKey: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----',
credentials: '{"type":"service_account", ...}',
accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
accessKey: 'my-azure-access-key',
uri: 'amqp://user:pass@rabbit.example.com:5672'
}
})
};
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',
'username' => 'default',
'tableName' => 'events',
'database' => 'analytics',
'accountIdentifier' => 'myorg-myaccount',
'userId' => 'SVC_AMPERSAND',
'dbName' => 'ANALYTICS',
'schemaName' => 'PUBLIC',
'projectId' => 'my-gcp-project',
'datasetId' => 'analytics',
'tableId' => 'events',
'workgroupName' => 'my-workgroup',
'clusterIdentifier' => 'my-cluster',
'dbUser' => 'ampersand',
'account' => 'mystorageaccount',
'container' => 'ampersand-data',
'queueUrl' => 'https://sqs.us-east-1.amazonaws.com/123456789012/my-queue',
'topicArn' => 'arn:aws:sns:us-east-1:123456789012:my-topic',
'eventBusName' => 'default',
'detailType' => 'ampersand.record',
'topicId' => 'ampersand-events',
'routingKey' => 'ampersand.events',
'batchSize' => 1000,
'maxWaitSecs' => 30
],
'secrets' => [
'awsKeyId' => 'AKIAIOSFODNN7EXAMPLE',
'awsSecretKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
'awsSessionToken' => 'AQoEXAMPLEH4aoAH0gNCAPy...',
'password' => 'my-clickhouse-password',
'privateKey' => '-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----',
'credentials' => '{"type":"service_account", ...}',
'accessKeyId' => 'AKIAIOSFODNN7EXAMPLE',
'secretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
'accessKey' => 'my-azure-access-key',
'uri' => 'amqp://user:pass@rabbit.example.com:5672'
]
]),
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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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 \"username\": \"default\",\n \"tableName\": \"events\",\n \"database\": \"analytics\",\n \"accountIdentifier\": \"myorg-myaccount\",\n \"userId\": \"SVC_AMPERSAND\",\n \"dbName\": \"ANALYTICS\",\n \"schemaName\": \"PUBLIC\",\n \"projectId\": \"my-gcp-project\",\n \"datasetId\": \"analytics\",\n \"tableId\": \"events\",\n \"workgroupName\": \"my-workgroup\",\n \"clusterIdentifier\": \"my-cluster\",\n \"dbUser\": \"ampersand\",\n \"account\": \"mystorageaccount\",\n \"container\": \"ampersand-data\",\n \"queueUrl\": \"https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\",\n \"topicArn\": \"arn:aws:sns:us-east-1:123456789012:my-topic\",\n \"eventBusName\": \"default\",\n \"detailType\": \"ampersand.record\",\n \"topicId\": \"ampersand-events\",\n \"routingKey\": \"ampersand.events\",\n \"batchSize\": 1000,\n \"maxWaitSecs\": 30\n },\n \"secrets\": {\n \"awsKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"awsSecretKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"awsSessionToken\": \"AQoEXAMPLEH4aoAH0gNCAPy...\",\n \"password\": \"my-clickhouse-password\",\n \"privateKey\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\",\n \"credentials\": \"{\\\"type\\\":\\\"service_account\\\", ...}\",\n \"accessKeyId\": \"AKIAIOSFODNN7EXAMPLE\",\n \"secretAccessKey\": \"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n \"accessKey\": \"my-azure-access-key\",\n \"uri\": \"amqp://user:pass@rabbit.example.com:5672\"\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",
"username": "default",
"tableName": "events",
"database": "analytics",
"accountIdentifier": "myorg-myaccount",
"userId": "SVC_AMPERSAND",
"dbName": "ANALYTICS",
"schemaName": "PUBLIC",
"projectId": "my-gcp-project",
"datasetId": "analytics",
"tableId": "events",
"workgroupName": "my-workgroup",
"clusterIdentifier": "my-cluster",
"dbUser": "ampersand",
"account": "mystorageaccount",
"container": "ampersand-data",
"queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
"topicArn": "arn:aws:sns:us-east-1:123456789012:my-topic",
"eventBusName": "default",
"detailType": "ampersand.record",
"topicId": "ampersand-events",
"routingKey": "ampersand.events",
"batchSize": 1000,
"maxWaitSecs": 30
},
"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
APIKeyHeaderBearer
Path Parameters
The Ampersand project ID or project name.
Body
application/json
Name for the new destination. Must be unique within the project and can only contain letters, numbers and dashes.
Example:
"leadConvertedWebhook"
The type of the destination. For slack, set metadata.url to a Slack incoming webhook URL. The warehouse and message-queue types (clickhouse, snowflake, bigquery, redshift, sqs, sns, eventbridge, pubsub, rabbitmq) are configured via the metadata and secrets fields documented below.
Available options:
webhook, kinesis, s3, slack, clickhouse, snowflake, bigquery, redshift, sqs, sns, eventbridge, pubsub, rabbitmq Example:
"webhook"
Show child attributes
Show child attributes
Secrets for the destination.
Show child attributes
Show child attributes
Response
Created
The destination ID.
User-defined name for the destination.
Example:
"leadConvertedWebhook"
The type of the destination.
Example:
"webhook"
Show child attributes
Show child attributes
The time the destination was created.
The time the destination was updated.
Was this page helpful?
⌘I