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 '
{
  "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"
  },
  "secrets": {
    "awsKeyId": "AKIAIOSFODNN7EXAMPLE",
    "awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy..."
  }
}
'

{
  "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}}"
  },
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "secrets": {
    "webhookSigningKey": "<string>"
  }
}

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 '
{
  "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"
  },
  "secrets": {
    "awsKeyId": "AKIAIOSFODNN7EXAMPLE",
    "awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "awsSessionToken": "AQoEXAMPLEH4aoAH0gNCAPy..."
  }
}
'

{
  "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}}"
  },
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "secrets": {
    "webhookSigningKey": "<string>"
  }
}

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

Example:

"webhook"

metadata

object

required

Show child attributes

metadata.url

string

Webhook URL, must start with "https://".

Example:

"https://webhooks.mailmonkey.com/salesforce-lead-converted"

metadata.headers

Webhook Headers · object

Additional headers to add when Ampersand sends a webhook message

Show child attributes

metadata.headers.{key}

string

Example:

{ "Authorization": "Bearer 1234" }

metadata.region

string

The AWS region where the kinesis destination is hosted.

Example:

"us-east-1"

metadata.streamName

string

The name of the Kinesis stream to send events to.

Example:

"my-kinesis-stream"

metadata.endpointUrl

string

The endpoint URL for the Kinesis stream.

Example:

"https://kinesis.us-east-1.amazonaws.com"

metadata.partitionKeyTemplate

string

The template for the partition key to use when sending events to Kinesis (a JMESPath template)

Example:

"data.user_id"

secrets

object

Secrets for the destination.

Show child attributes

secrets.awsKeyId

string

The AWS access key ID for the Kinesis destination.

Example:

"AKIAIOSFODNN7EXAMPLE"

secrets.awsSecretKey

string

The AWS secret access key for the Kinesis destination.

Example:

"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

secrets.awsSessionToken

string

The AWS session token for the Kinesis destination.

Example:

"AQoEXAMPLEH4aoAH0gNCAPy..."

Response

Created

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

Show child attributes

metadata.url

string

Webhook URL

Example:

"https://webhooks.mailmonkey.com/salesforce-lead-converted"

metadata.headers

Webhook Headers · object

Additional headers to add when Ampersand sends a webhook message

Show child attributes

metadata.headers.{key}

string

Example:

{ "Authorization": "Bearer 1234" }

metadata.streamName

string

The name of the Kinesis stream

Example:

"my-data-stream"

metadata.region

string

The AWS region for the destination

Example:

"us-east-1"

metadata.partitionKeyTemplate

string

Template for generating partition keys

Example:

"{{.integration_id}}"

createTime

string<date-time>

required

The time the destination was created.

updateTime

string<date-time>

The time the destination was updated.

secrets

object

Destination secrets (only included when includeSecrets is true)

Show child attributes

secrets.webhookSigningKey

string

Webhook signing key for the destination (only included for webhook destinations)

List destinations Get a destination

⌘I

Authentication

WRITE API

READ API

PLATFORM API

Create a new destination

Authorizations

Path Parameters

Body

Response