Add a webhook or email destination

Adds or changes a webhook or an email list that Ziplined can send people to. Adds a destination that syncs can send people to. That is a webhook (an https URL) or an email list (1 to 20 addresses). A webhook first gets a signed test event. Ziplined saves it only when it answers with a 2xx within ten seconds. The answer for a webhook carries its signing secret exactly once. Give the secret to the user to store in the receiving system, because Ziplined cannot show it again. Give the destination a name when the workspace has more than one. Email goes only to members of this workspace, and to addresses on a member's company domain. The first call saves and sends nothing. It returns a summary of where people will go, and a confirm_id. It saves when you call again with the same arguments plus confirm_id, once the user agreed. With destination, it updates a destination that exists. name renames it. paused: true pauses every sync to it and keeps their choices. paused: false resumes them, and sends only the people who enter from then on. url (webhook) or to (email) replaces where it points, and asks first in the same way. A new url gets a new secret, shown once. A rename or a pause needs no confirm_id. The connection of Slack or another app is a secret, and never an argument. connect_destination gives the user a link to connect it again. fields says what a webhook or a Clay table gets about each person. list_destinations shows the fields of each destination. You cannot change the columns of a Google Sheets tab. Use when: The user wants people sent to their own endpoint (Make, Zapier, n8n) or to a list of email addresses. Or the user wants to rename a destination, or pause or resume every sync to it. Or the user wants to point a webhook or email list elsewhere. Do not use for: Slack and other apps: they need a sign-in or a key that you never pass as an argument. Use connect_destination instead, which also replaces their connection. Pausing one sync (use save_sync with paused instead). Example: {"provider":"webhook","url":"https://hook.eu2.make.com/abc123","name":"Make leads"}

POST

integrations

curl --request POST \
  --url https://api.ziplined.io/v1/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "url": "<string>",
  "to": [
    "[email protected]"
  ],
  "paused": true,
  "name": "<string>",
  "fields": [
    "<string>"
  ],
  "confirm_id": "<string>"
}
'

import requests

url = "https://api.ziplined.io/v1/integrations"

payload = {
    "destination": "<string>",
    "url": "<string>",
    "to": ["[email protected]"],
    "paused": True,
    "name": "<string>",
    "fields": ["<string>"],
    "confirm_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    url: '<string>',
    to: ['[email protected]'],
    paused: true,
    name: '<string>',
    fields: ['<string>'],
    confirm_id: '<string>'
  })
};

fetch('https://api.ziplined.io/v1/integrations', 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.ziplined.io/v1/integrations",
  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([
    'destination' => '<string>',
    'url' => '<string>',
    'to' => [
        '[email protected]'
    ],
    'paused' => true,
    'name' => '<string>',
    'fields' => [
        '<string>'
    ],
    'confirm_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.ziplined.io/v1/integrations"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.ziplined.io/v1/integrations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/integrations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "destination": {
    "id": "<string>",
    "provider": "<string>",
    "name": "<string>",
    "status": "connected",
    "host": "<string>",
    "created_at": "<string>",
    "last_delivery": {
      "status": "<string>",
      "at": "<string>"
    },
    "failed_deliveries": 123,
    "fields": [
      "<string>"
    ]
  },
  "secret": "<string>",
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key

string

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255

Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json

destination

string

An existing destination, by name or id from list_destinations: the call updates it instead of adding one. With it, pass name, paused, url (webhook) or to (email); provider is not needed.

Required string length: 1 - 200

provider

enum<string>

For a new destination: webhook or email. connect_destination connects Slack and other apps.

Available options:

webhook,

email

url

string<uri>

For webhook: the https URL that receives the signed events. On an update it replaces the URL and makes a new secret.

string<email>[]

For email: the addresses that receive the emails, 1 to 20. On an update it replaces the list.

Required array length: 1 - 20 elements

paused

boolean

Only with destination. true pauses every sync to it: they send nothing until you resume them. The syncs keep their choices. false resumes them. They do not send the people who entered a view during the pause.

name

string

A name to tell destinations apart, such as "Make leads". list_destinations shows it, and save_sync takes it.

Required string length: 1 - 120

fields

string[]

For webhook and Clay: what it sends about each person, as field keys in order. Examples: first_name, last_name, job_title, company, signal, post_topic, post_url, ziplined_url. An unknown key gets an error with all keys. Left out, a new webhook gets the default set. You cannot change the columns of a Google Sheets tab.

Maximum array length: 27

confirm_id

string

The confirm_id of a needs_confirmation answer: commits what that answer summarised.

Response

The result, or without confirm_id first a needs_confirmation answer: nothing happened yet.

Option 1
Option 2

destination

object

required

Show child attributes

secret

string | null

required

The webhook signing secret, shown this one time. Null for email, and null when this answer is a replay. A lost secret is not recoverable: rotate it with POST /v1/integrations/{id}/rotate-secret.

app_url

string

required

Add a webhook or email destination

curl --request POST \
  --url https://api.ziplined.io/v1/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "url": "<string>",
  "to": [
    "[email protected]"
  ],
  "paused": true,
  "name": "<string>",
  "fields": [
    "<string>"
  ],
  "confirm_id": "<string>"
}
'

import requests

url = "https://api.ziplined.io/v1/integrations"

payload = {
    "destination": "<string>",
    "url": "<string>",
    "to": ["[email protected]"],
    "paused": True,
    "name": "<string>",
    "fields": ["<string>"],
    "confirm_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    url: '<string>',
    to: ['[email protected]'],
    paused: true,
    name: '<string>',
    fields: ['<string>'],
    confirm_id: '<string>'
  })
};

fetch('https://api.ziplined.io/v1/integrations', 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.ziplined.io/v1/integrations",
  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([
    'destination' => '<string>',
    'url' => '<string>',
    'to' => [
        '[email protected]'
    ],
    'paused' => true,
    'name' => '<string>',
    'fields' => [
        '<string>'
    ],
    'confirm_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.ziplined.io/v1/integrations"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.ziplined.io/v1/integrations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/integrations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": \"<string>\",\n  \"url\": \"<string>\",\n  \"to\": [\n    \"[email protected]\"\n  ],\n  \"paused\": true,\n  \"name\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"confirm_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "destination": {
    "id": "<string>",
    "provider": "<string>",
    "name": "<string>",
    "status": "connected",
    "host": "<string>",
    "created_at": "<string>",
    "last_delivery": {
      "status": "<string>",
      "at": "<string>"
    },
    "failed_deliveries": 123,
    "fields": [
      "<string>"
    ]
  },
  "secret": "<string>",
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

People

Companies

Posts

Engagements

Insights

Views

Audiences

ICP

Sources

Account

Credits

Integrations

Add a webhook or email destination

Authorizations

Headers

Body

Response