curl --request POST \
--url https://app.gtm-api.com/orchestration/v4/api/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"target_url": "<string>",
"events": [],
"filters": {
"account_sid": "<string>",
"where": {}
}
}
'import requests
url = "https://app.gtm-api.com/orchestration/v4/api/webhooks"
payload = {
"name": "<string>",
"target_url": "<string>",
"events": [],
"filters": {
"account_sid": "<string>",
"where": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
target_url: '<string>',
events: [],
filters: {account_sid: '<string>', where: {}}
})
};
fetch('https://app.gtm-api.com/orchestration/v4/api/webhooks', 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://app.gtm-api.com/orchestration/v4/api/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' => '<string>',
'target_url' => '<string>',
'events' => [
],
'filters' => [
'account_sid' => '<string>',
'where' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://app.gtm-api.com/orchestration/v4/api/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://app.gtm-api.com/orchestration/v4/api/webhooks")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/orchestration/v4/api/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"target_url": "<string>",
"events": [
"<string>"
],
"filters": {},
"status": "on",
"consecutive_failed_attempts": 123,
"last_failure_at": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"secret": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}Create webhook
Create a webhook subscription endpoint. The server generates a 32-char hex secret and returns it ONCE in this response (masked on every subsequent read). Store it client-side for HMAC verification. target_url must be https:// and public (non-RFC1918); each events[] value is validated against WebhookEventTypeEnum; the same target_url cannot be registered twice per team. State-changing.
Contract:
- MCP tool
create_webhook, registry packagemcp.orchestration/webhooks, mountorchestration.webhooks. - Operation
create, response envelopecreate. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
curl --request POST \
--url https://app.gtm-api.com/orchestration/v4/api/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"name": "<string>",
"target_url": "<string>",
"events": [],
"filters": {
"account_sid": "<string>",
"where": {}
}
}
'import requests
url = "https://app.gtm-api.com/orchestration/v4/api/webhooks"
payload = {
"name": "<string>",
"target_url": "<string>",
"events": [],
"filters": {
"account_sid": "<string>",
"where": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
target_url: '<string>',
events: [],
filters: {account_sid: '<string>', where: {}}
})
};
fetch('https://app.gtm-api.com/orchestration/v4/api/webhooks', 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://app.gtm-api.com/orchestration/v4/api/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' => '<string>',
'target_url' => '<string>',
'events' => [
],
'filters' => [
'account_sid' => '<string>',
'where' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://app.gtm-api.com/orchestration/v4/api/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<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://app.gtm-api.com/orchestration/v4/api/webhooks")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/orchestration/v4/api/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target_url\": \"<string>\",\n \"events\": [],\n \"filters\": {\n \"account_sid\": \"<string>\",\n \"where\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "create",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"target_url": "<string>",
"events": [
"<string>"
],
"filters": {},
"status": "on",
"consecutive_failed_attempts": 123,
"last_failure_at": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"secret": "<string>"
},
"already_exists": true,
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}Authorizations
Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
Request body of create_webhook.
1 - 255https:// only, public IP only.
2048At least one WebhookEventTypeEnum value.
1linkedin-accounts.created, linkedin-accounts.restored, linkedin-accounts.deleted, linkedin-accounts.initial-sync-started, linkedin-accounts.initial-sync-done, linkedin-accounts.sync-reset, linkedin-accounts.sync-config-updated, linkedin-accounts.premium-changed, linkedin-accounts.login-succeeded, linkedin-accounts.login-failed, linkedin-accounts.logged-out, linkedin-accounts.heartbeat-stale, linkedin-accounts.subscription-hold-applied, linkedin-accounts.subscription-hold-released, linkedin-account-block-log.recorded, linkedin-account-snapshot.captured, linkedin-account-quota-hits.recorded, linkedin-account-smart-limits.limit-reached, linkedin-account-smart-limits.limit-released, linkedin-account-smart-limits.smart-limit-recomputed, linkedin-account-smart-limits.ceiling-learned, linkedin-connection-requests.sent, linkedin-connection-requests.accepted, linkedin-connection-requests.withdrawn, linkedin-connection-requests.expired-detected, linkedin-connection-requests.resend-available, linkedin-connection-requests.sync-completed, linkedin-connection-invitations.received, linkedin-connection-invitations.accepted, linkedin-connection-invitations.ignored, linkedin-connection-invitations.expired-detected, linkedin-connection-invitations.sync-completed, linkedin-connections.added, linkedin-connections.removed, linkedin-connections.sync-completed, linkedin-followers.added, linkedin-messages.received, linkedin-messages.sent, linkedin-messages.send-failed, linkedin-conversations.created, linkedin-conversations.sync-completed, data-requests.completed, data-requests.failed, linkedin-auto-scrape-runs.completed, linkedin-auto-scrape-runs.failed, linkedin-auto-scrapes.paused, antidetect-browsers.logged-in, antidetect-browsers.login-failed, antidetect-browsers.logged-out, antidetect-browsers.started, antidetect-browsers.stopped, antidetect-browsers.start-failed, antidetect-browsers.running-issue, antidetect-browsers.error-investigation, antidetect-browsers.maintenance, antidetect-browsers.proxy-issue, antidetect-browsers.proxy-back-alive, antidetect-browsers.idle, account-shares.created, account-shares.returned, account-shares.recalled, account-shares.failed, account-transfers.completed, account-transfers.failed, webhooks.failed, email-accounts.connected, email-accounts.reconnect-required, email-accounts.sending-paused, email-accounts.sending-resumed, email-accounts.disconnected, email-accounts.deleted, email-accounts.sync-completed, email-accounts.subscription-hold-applied, email-accounts.subscription-hold-released, email-messages.received, email-messages.sent, email-messages.bounced, email-messages.complained, email-messages.failed, email-messages.deleted, email-threads.updated, email-engagements.opened, email-engagements.clicked, email-engagements.unsubscribed, email-account-health.snapshot-captured, email-account-health.score-critical, email-suppressions.created, email-suppressions.deleted, email-tracking-domains.verified, email-tracking-domains.failed, email-sending-domains.verified, email-sending-domains.failed, mass-actions.created, mass-actions.paused, mass-actions.resumed, mass-actions.settled, * Optional narrowing (e.g. status, events).
Show child attributes
Show child attributes