Skip to main content
POST
Create a destination

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Headers

Idempotency-Key
string

Up to 255 characters. The same key within 24 hours replays the first answer and creates nothing new. Build it from your own record, such as order-8842-reminder-1.

Maximum string length: 200

Body

application/json
name
string
required
Required string length: 1 - 100
emails
string<email>[]

An email endpoint's addresses. Only for type email.

Required array length: 1 - 10 elements
Maximum string length: 254
enabled
boolean
headers
object
method
enum<string>
Available options:
POST
type
enum<string>
default:https
Available options:
https,
email
url
string<uri>
Required string length: 1 - 2048
Pattern: ^https://

Response

Created

created_at
string<date-time>
required
enabled
boolean
required
header_names
string[]
required
id
string
required
name
string
required
object
string
required
revision
integer
required
signing_key_version
integer
required
signing_secret
string
required
emails
object[]
health
object
method
string
type
string
url
string