Create an integration hook
curl --request POST \
--url https://rest.breakcold.com/api/v1/integration-hooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "workspace_id",
"platform": "zapier",
"targetUrl": "https://hooks.zapier.com/hooks/catch/123/abc",
"eventType": "record.created"
}
'import requests
url = "https://rest.breakcold.com/api/v1/integration-hooks"
payload = {
"workspaceId": "workspace_id",
"platform": "zapier",
"targetUrl": "https://hooks.zapier.com/hooks/catch/123/abc",
"eventType": "record.created"
}
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({
workspaceId: 'workspace_id',
platform: 'zapier',
targetUrl: 'https://hooks.zapier.com/hooks/catch/123/abc',
eventType: 'record.created'
})
};
fetch('https://rest.breakcold.com/api/v1/integration-hooks', 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://rest.breakcold.com/api/v1/integration-hooks",
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([
'workspaceId' => 'workspace_id',
'platform' => 'zapier',
'targetUrl' => 'https://hooks.zapier.com/hooks/catch/123/abc',
'eventType' => 'record.created'
]),
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://rest.breakcold.com/api/v1/integration-hooks"
payload := strings.NewReader("{\n \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\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://rest.breakcold.com/api/v1/integration-hooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/integration-hooks")
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 \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\n}"
response = http.request(request)
puts response.read_body{
"hook": {
"id": "<string>",
"endpointId": "<string>",
"workspaceId": "<string>"
}
}{
"hook": {
"id": "<string>",
"endpointId": "<string>",
"workspaceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}Webhooks
Create an integration hook
Create and activate a Zapier or Make webhook subscription that delivers matching future Breakcold events to the supplied external HTTPS URL.
| Token cost | Rate limit |
|---|---|
| 40 tokens | 120 requests/min per route/org |
POST
/
integration-hooks
Create an integration hook
curl --request POST \
--url https://rest.breakcold.com/api/v1/integration-hooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "workspace_id",
"platform": "zapier",
"targetUrl": "https://hooks.zapier.com/hooks/catch/123/abc",
"eventType": "record.created"
}
'import requests
url = "https://rest.breakcold.com/api/v1/integration-hooks"
payload = {
"workspaceId": "workspace_id",
"platform": "zapier",
"targetUrl": "https://hooks.zapier.com/hooks/catch/123/abc",
"eventType": "record.created"
}
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({
workspaceId: 'workspace_id',
platform: 'zapier',
targetUrl: 'https://hooks.zapier.com/hooks/catch/123/abc',
eventType: 'record.created'
})
};
fetch('https://rest.breakcold.com/api/v1/integration-hooks', 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://rest.breakcold.com/api/v1/integration-hooks",
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([
'workspaceId' => 'workspace_id',
'platform' => 'zapier',
'targetUrl' => 'https://hooks.zapier.com/hooks/catch/123/abc',
'eventType' => 'record.created'
]),
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://rest.breakcold.com/api/v1/integration-hooks"
payload := strings.NewReader("{\n \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\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://rest.breakcold.com/api/v1/integration-hooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/integration-hooks")
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 \"workspaceId\": \"workspace_id\",\n \"platform\": \"zapier\",\n \"targetUrl\": \"https://hooks.zapier.com/hooks/catch/123/abc\",\n \"eventType\": \"record.created\"\n}"
response = http.request(request)
puts response.read_body{
"hook": {
"id": "<string>",
"endpointId": "<string>",
"workspaceId": "<string>"
}
}{
"hook": {
"id": "<string>",
"endpointId": "<string>",
"workspaceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}Authorizations
ApiKeyBearerBreakcoldOAuth
Breakcold public API key, for example Bearer bc_live_....
Headers
Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.
Body
application/json
Minimum string length:
6Available options:
zapier, make Available options:
record.created, record.updated, record.deleted, note.created, note.updated, note.deleted, task.created, task.completed, relation.added, relation.removed, call.linked, call.unlinked, file.uploaded, file.deleted Minimum string length:
6Response
Success
Show child attributes
Show child attributes
Was this page helpful?
⌘I