curl --request POST \
--url https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Reply notifications",
"url": "https://example.com/webhooks/salesforge",
"sequenceID": "seq_abc123",
"sequenceIds": [
"seq_abc123",
"seq_def456"
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch('https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch('https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks';
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks"
payload = {
"name": "Reply notifications",
"url": "https://example.com/webhooks/salesforge",
"sequenceID": "seq_abc123",
"sequenceIds": ["seq_abc123", "seq_def456"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks"
payload := strings.NewReader("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks",
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' => 'Reply notifications',
'url' => 'https://example.com/webhooks/salesforge',
'sequenceID' => 'seq_abc123',
'sequenceIds' => [
'seq_abc123',
'seq_def456'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"sentCount": 123,
"sequenceId": "<string>",
"sequenceIds": [
"<string>"
],
"signingSecret": "<string>",
"type": "email_sent",
"url": "<string>"
}{
"data": [
{
"createdAt": "<string>",
"type": "email",
"value": "<string>"
}
],
"message": "<string>"
}Create webhook
Create a new webhook.
curl --request POST \
--url https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Reply notifications",
"url": "https://example.com/webhooks/salesforge",
"sequenceID": "seq_abc123",
"sequenceIds": [
"seq_abc123",
"seq_def456"
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch('https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch('https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks';
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Reply notifications',
url: 'https://example.com/webhooks/salesforge',
sequenceID: 'seq_abc123',
sequenceIds: ['seq_abc123', 'seq_def456']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks"
payload = {
"name": "Reply notifications",
"url": "https://example.com/webhooks/salesforge",
"sequenceID": "seq_abc123",
"sequenceIds": ["seq_abc123", "seq_def456"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks"
payload := strings.NewReader("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks",
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' => 'Reply notifications',
'url' => 'https://example.com/webhooks/salesforge',
'sequenceID' => 'seq_abc123',
'sequenceIds' => [
'seq_abc123',
'seq_def456'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.salesforge.ai/public/v2/workspaces/{workspaceID}/integrations/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Reply notifications\",\n \"url\": \"https://example.com/webhooks/salesforge\",\n \"sequenceID\": \"seq_abc123\",\n \"sequenceIds\": [\n \"seq_abc123\",\n \"seq_def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"sentCount": 123,
"sequenceId": "<string>",
"sequenceIds": [
"<string>"
],
"signingSecret": "<string>",
"type": "email_sent",
"url": "<string>"
}{
"data": [
{
"createdAt": "<string>",
"type": "email",
"value": "<string>"
}
],
"message": "<string>"
}Authorizations
Path Parameters
Workspace ID
Body
Request body
Request body
Label identifying this webhook in the workspace.
"Reply notifications"
Event that triggers a delivery. A webhook subscribes to exactly one type, so receiving several events means registering several webhooks.
email_sent, email_opened, link_clicked, email_replied, linkedin_replied, contact_unsubscribed, email_bounced, positive_reply, negative_reply, label_changed, dnc_added, meeting_booked, meeting_completed, linkedin_message_sent, linkedin_inmail_sent, linkedin_connection_request_sent, linkedin_connection_request_accepted, linkedin_connection_request_withdrawn, linkedin_profile_viewed, linkedin_post_liked, linkedin_contact_followed, email_sent, email_opened, link_clicked, email_replied, linkedin_replied, contact_unsubscribed, email_bounced, positive_reply, negative_reply, label_changed, dnc_added, meeting_booked, meeting_completed, linkedin_message_sent, linkedin_inmail_sent, linkedin_connection_request_sent, linkedin_connection_request_accepted, linkedin_connection_request_withdrawn, linkedin_profile_viewed, linkedin_post_liked, linkedin_contact_followed Endpoint receiving the POST. Must be publicly reachable and answer 2xx: a failed delivery is not retried.
"https://example.com/webhooks/salesforge"
Deprecated: use sequenceIds. Ignored when sequenceIds is non-empty.
1"seq_abc123"
Sequences whose events this webhook receives. Omit or leave empty to receive events for every sequence in the workspace.
["seq_abc123", "seq_def456"]
Response
Created webhook. The signingSecret is returned only here and cannot be retrieved later.
SigningSecret is returned exactly once, at creation, and cannot be retrieved afterwards.
Event that triggers a delivery. A webhook subscribes to exactly one type, so receiving several events means registering several webhooks.
email_sent, email_opened, link_clicked, email_replied, linkedin_replied, contact_unsubscribed, email_bounced, positive_reply, negative_reply, label_changed, dnc_added, meeting_booked, meeting_completed, linkedin_message_sent, linkedin_inmail_sent, linkedin_connection_request_sent, linkedin_connection_request_accepted, linkedin_connection_request_withdrawn, linkedin_profile_viewed, linkedin_post_liked, linkedin_contact_followed, email_sent, email_opened, link_clicked, email_replied, linkedin_replied, contact_unsubscribed, email_bounced, positive_reply, negative_reply, label_changed, dnc_added, meeting_booked, meeting_completed, linkedin_message_sent, linkedin_inmail_sent, linkedin_connection_request_sent, linkedin_connection_request_accepted, linkedin_connection_request_withdrawn, linkedin_profile_viewed, linkedin_post_liked, linkedin_contact_followed 