Add a webhook to an SDK Connection
Called whenever the connection’s payload changes. httpMethod defaults to POST. More than one webhook per organization requires a paid plan. The change is recorded as a published revision of the connection. When the organization requires approvals for the connection, add it in a draft revision instead (POST /sdk-connections-revisions/{id}/new/webhooks), or pass bypassApproval.
curl -X POST 'https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks"
payload = {
"name": "<string>",
"endpoint": "<string>",
"payloadKey": "<string>",
"headers": "<string>",
"timeoutSeconds": 2,
"bypassApproval": True,
"ignoreWarnings": True,
"skipHooks": True
}
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({
name: '<string>',
endpoint: '<string>',
payloadKey: '<string>',
headers: '<string>',
timeoutSeconds: 2,
bypassApproval: true,
ignoreWarnings: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/sdk-connections/{id}/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://api.growthbook.io/api/v1/sdk-connections/{id}/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>',
'endpoint' => '<string>',
'payloadKey' => '<string>',
'headers' => '<string>',
'timeoutSeconds' => 2,
'bypassApproval' => true,
'ignoreWarnings' => true,
'skipHooks' => true
]),
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.growthbook.io/api/v1/sdk-connections/{id}/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\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.growthbook.io/api/v1/sdk-connections/{id}/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks")
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 \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\n}"
response = http.request(request)
puts response.read_body{
"sdkWebhook": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"endpoint": "<string>",
"sdkConnections": [
"<string>"
],
"httpMethod": "GET",
"payloadFormat": "standard",
"lastSuccess": "2023-11-07T05:31:56Z",
"error": "<string>",
"consecutiveFailures": 123,
"disabled": true,
"timeoutSeconds": 2,
"payloadKey": "<string>",
"headers": "<string>",
"signingKey": "<string>"
},
"bypassedGates": [
{
"type": "<string>",
"outcome": "bypassed",
"via": "ignoreWarnings"
}
]
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}Authorizations
Pass your API key as the Bearer token. See Authentication.
Body
Set to true to continue past a warning: one raised by a Custom Hook, or a webhook that references a secret that doesn't exist. On publish, it also force-publishes an out-of-date draft when the caller has Bypass draft approvals access. It never clears a Custom Hook rejection. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Set to true to continue despite a Custom Hook rejection. The caller must have Bypass draft approvals access for SDK Connections in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Was this page helpful?
curl -X POST 'https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks"
payload = {
"name": "<string>",
"endpoint": "<string>",
"payloadKey": "<string>",
"headers": "<string>",
"timeoutSeconds": 2,
"bypassApproval": True,
"ignoreWarnings": True,
"skipHooks": True
}
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({
name: '<string>',
endpoint: '<string>',
payloadKey: '<string>',
headers: '<string>',
timeoutSeconds: 2,
bypassApproval: true,
ignoreWarnings: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/sdk-connections/{id}/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://api.growthbook.io/api/v1/sdk-connections/{id}/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>',
'endpoint' => '<string>',
'payloadKey' => '<string>',
'headers' => '<string>',
'timeoutSeconds' => 2,
'bypassApproval' => true,
'ignoreWarnings' => true,
'skipHooks' => true
]),
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.growthbook.io/api/v1/sdk-connections/{id}/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\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.growthbook.io/api/v1/sdk-connections/{id}/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/sdk-connections/{id}/webhooks")
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 \"name\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"payloadKey\": \"<string>\",\n \"headers\": \"<string>\",\n \"timeoutSeconds\": 2,\n \"bypassApproval\": true,\n \"ignoreWarnings\": true,\n \"skipHooks\": true\n}"
response = http.request(request)
puts response.read_body{
"sdkWebhook": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"endpoint": "<string>",
"sdkConnections": [
"<string>"
],
"httpMethod": "GET",
"payloadFormat": "standard",
"lastSuccess": "2023-11-07T05:31:56Z",
"error": "<string>",
"consecutiveFailures": 123,
"disabled": true,
"timeoutSeconds": 2,
"payloadKey": "<string>",
"headers": "<string>",
"signingKey": "<string>"
},
"bypassedGates": [
{
"type": "<string>",
"outcome": "bypassed",
"via": "ignoreWarnings"
}
]
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}
