Update a webhook subscription
curl --request POST \
--url https://{notifuseDomain}/api/webhookSubscriptions.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook Updated",
"url": "https://api.example.com/webhooks/notifuse/v2",
"event_types": [
"contact.created",
"contact.updated",
"contact.deleted"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
],
"enabled": true
}
'import requests
url = "https://{notifuseDomain}/api/webhookSubscriptions.update"
payload = {
"workspace_id": "ws_1234567890",
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook Updated",
"url": "https://api.example.com/webhooks/notifuse/v2",
"event_types": ["contact.created", "contact.updated", "contact.deleted"],
"custom_event_filters": {
"goal_types": ["purchase", "subscription"],
"event_names": ["orders/fulfilled", "payment.succeeded"]
},
"list_ids": ["newsletter", "product_updates"],
"segment_ids": ["vip_customers"],
"enabled": 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({
workspace_id: 'ws_1234567890',
id: 'whsub_a1b2c3d4e5f6',
name: 'Production Webhook Updated',
url: 'https://api.example.com/webhooks/notifuse/v2',
event_types: ['contact.created', 'contact.updated', 'contact.deleted'],
custom_event_filters: {
goal_types: ['purchase', 'subscription'],
event_names: ['orders/fulfilled', 'payment.succeeded']
},
list_ids: ['newsletter', 'product_updates'],
segment_ids: ['vip_customers'],
enabled: true
})
};
fetch('https://{notifuseDomain}/api/webhookSubscriptions.update', 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://{notifuseDomain}/api/webhookSubscriptions.update",
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([
'workspace_id' => 'ws_1234567890',
'id' => 'whsub_a1b2c3d4e5f6',
'name' => 'Production Webhook Updated',
'url' => 'https://api.example.com/webhooks/notifuse/v2',
'event_types' => [
'contact.created',
'contact.updated',
'contact.deleted'
],
'custom_event_filters' => [
'goal_types' => [
'purchase',
'subscription'
],
'event_names' => [
'orders/fulfilled',
'payment.succeeded'
]
],
'list_ids' => [
'newsletter',
'product_updates'
],
'segment_ids' => [
'vip_customers'
],
'enabled' => 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://{notifuseDomain}/api/webhookSubscriptions.update"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": 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://{notifuseDomain}/api/webhookSubscriptions.update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/webhookSubscriptions.update")
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 \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook",
"url": "https://api.example.com/webhooks/notifuse",
"secret": "whsec_a1b2c3d4e5f6g7h8i9j0",
"settings": {
"event_types": [
"contact.created",
"contact.updated",
"email.sent"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
]
},
"event_types": [
"contact.created",
"contact.updated",
"email.sent"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
],
"enabled": true,
"last_delivery_at": "2024-01-15T10:30:00Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}Webhooks
Update a webhook subscription
Updates an existing webhook subscription with new configuration.
POST
/
api
/
webhookSubscriptions.update
Update a webhook subscription
curl --request POST \
--url https://{notifuseDomain}/api/webhookSubscriptions.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook Updated",
"url": "https://api.example.com/webhooks/notifuse/v2",
"event_types": [
"contact.created",
"contact.updated",
"contact.deleted"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
],
"enabled": true
}
'import requests
url = "https://{notifuseDomain}/api/webhookSubscriptions.update"
payload = {
"workspace_id": "ws_1234567890",
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook Updated",
"url": "https://api.example.com/webhooks/notifuse/v2",
"event_types": ["contact.created", "contact.updated", "contact.deleted"],
"custom_event_filters": {
"goal_types": ["purchase", "subscription"],
"event_names": ["orders/fulfilled", "payment.succeeded"]
},
"list_ids": ["newsletter", "product_updates"],
"segment_ids": ["vip_customers"],
"enabled": 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({
workspace_id: 'ws_1234567890',
id: 'whsub_a1b2c3d4e5f6',
name: 'Production Webhook Updated',
url: 'https://api.example.com/webhooks/notifuse/v2',
event_types: ['contact.created', 'contact.updated', 'contact.deleted'],
custom_event_filters: {
goal_types: ['purchase', 'subscription'],
event_names: ['orders/fulfilled', 'payment.succeeded']
},
list_ids: ['newsletter', 'product_updates'],
segment_ids: ['vip_customers'],
enabled: true
})
};
fetch('https://{notifuseDomain}/api/webhookSubscriptions.update', 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://{notifuseDomain}/api/webhookSubscriptions.update",
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([
'workspace_id' => 'ws_1234567890',
'id' => 'whsub_a1b2c3d4e5f6',
'name' => 'Production Webhook Updated',
'url' => 'https://api.example.com/webhooks/notifuse/v2',
'event_types' => [
'contact.created',
'contact.updated',
'contact.deleted'
],
'custom_event_filters' => [
'goal_types' => [
'purchase',
'subscription'
],
'event_names' => [
'orders/fulfilled',
'payment.succeeded'
]
],
'list_ids' => [
'newsletter',
'product_updates'
],
'segment_ids' => [
'vip_customers'
],
'enabled' => 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://{notifuseDomain}/api/webhookSubscriptions.update"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": 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://{notifuseDomain}/api/webhookSubscriptions.update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/webhookSubscriptions.update")
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 \"workspace_id\": \"ws_1234567890\",\n \"id\": \"whsub_a1b2c3d4e5f6\",\n \"name\": \"Production Webhook Updated\",\n \"url\": \"https://api.example.com/webhooks/notifuse/v2\",\n \"event_types\": [\n \"contact.created\",\n \"contact.updated\",\n \"contact.deleted\"\n ],\n \"custom_event_filters\": {\n \"goal_types\": [\n \"purchase\",\n \"subscription\"\n ],\n \"event_names\": [\n \"orders/fulfilled\",\n \"payment.succeeded\"\n ]\n },\n \"list_ids\": [\n \"newsletter\",\n \"product_updates\"\n ],\n \"segment_ids\": [\n \"vip_customers\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "whsub_a1b2c3d4e5f6",
"name": "Production Webhook",
"url": "https://api.example.com/webhooks/notifuse",
"secret": "whsec_a1b2c3d4e5f6g7h8i9j0",
"settings": {
"event_types": [
"contact.created",
"contact.updated",
"email.sent"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
]
},
"event_types": [
"contact.created",
"contact.updated",
"email.sent"
],
"custom_event_filters": {
"goal_types": [
"purchase",
"subscription"
],
"event_names": [
"orders/fulfilled",
"payment.succeeded"
]
},
"list_ids": [
"newsletter",
"product_updates"
],
"segment_ids": [
"vip_customers"
],
"enabled": true,
"last_delivery_at": "2024-01-15T10:30:00Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}Authorizations
API token for authentication
Body
application/json
A replace for what identifies the subscription — name, url and event_types are required and are written as sent — and a patch for everything that narrows it. Omitting enabled, custom_event_filters, list_ids or segment_ids leaves the stored value alone; a JSON null reads the same way. Send an explicitly empty array or object to remove a filter.
The ID of the workspace
Example:
"ws_1234567890"
The ID of the subscription to update
Example:
"whsub_a1b2c3d4e5f6"
Updated name
Example:
"Production Webhook Updated"
Updated URL
Example:
"https://api.example.com/webhooks/notifuse/v2"
Updated list of event types
Example:
[
"contact.created",
"contact.updated",
"contact.deleted"
]
Filters for the custom_event.* events. Omit it to leave the stored filters unchanged; send an empty object to stop filtering custom events.
Show child attributes
Show child attributes
Lists the list.* events are narrowed to. Omit it to leave the stored filter unchanged — a body that never mentions it cannot widen the subscription — and send an empty array to remove the narrowing.
Example:
["newsletter", "product_updates"]
Segments the segment.* events are narrowed to. Omit it to leave the stored filter unchanged; send an empty array to remove the narrowing.
Example:
["vip_customers"]
Whether the subscription is enabled. Omit it to leave the stored value unchanged; send it only to switch the subscription on or off.
Example:
true
Response
Webhook subscription updated successfully
A webhook subscription that receives HTTP callbacks when events occur
Show child attributes
Show child attributes