Update a subscription
curl --request PUT \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123
},
"source_id": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}"
payload = {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": ["<string>"],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123
},
"source_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
alert_config: {count: 123, threshold: '<string>'},
app_id: '<string>',
endpoint_id: '<string>',
filter_config: {event_types: ['<string>'], filter: {body: JSON.stringify({}), headers: {}}},
function: '<string>',
name: '<string>',
rate_limit_config: {count: 123, duration: 123},
retry_config: {duration: '<string>', interval_seconds: 123, retry_count: 123},
source_id: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}', 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://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'alert_config' => [
'count' => 123,
'threshold' => '<string>'
],
'app_id' => '<string>',
'endpoint_id' => '<string>',
'filter_config' => [
'event_types' => [
'<string>'
],
'filter' => [
'body' => [
],
'headers' => [
]
]
],
'function' => '<string>',
'name' => '<string>',
'rate_limit_config' => [
'count' => 123,
'duration' => 123
],
'retry_config' => [
'duration' => '<string>',
'interval_seconds' => 123,
'retry_count' => 123
],
'source_id' => '<string>'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}"
payload := strings.NewReader("{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"created_at": "<string>",
"deleted_at": "<string>",
"device_metadata": {
"created_at": "<string>",
"deleted_at": "<string>",
"endpoint_id": "<string>",
"host_name": "<string>",
"last_seen_at": "<string>",
"project_id": "<string>",
"uid": "<string>",
"updated_at": "<string>"
},
"endpoint_metadata": {
"advanced_signatures": true,
"authentication": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"oauth2": {
"audience": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"field_mapping": {
"access_token": "<string>",
"expires_in": "<string>",
"token_type": "<string>"
},
"grant_type": "<string>",
"issuer": "<string>",
"scope": "<string>",
"signing_algorithm": "<string>",
"signing_key": {
"crv": "<string>",
"d": "<string>",
"dp": "<string>",
"dq": "<string>",
"e": "<string>",
"kid": "<string>",
"kty": "<string>",
"n": "<string>",
"p": "<string>",
"q": "<string>",
"qi": "<string>",
"x": "<string>",
"y": "<string>"
},
"subject": "<string>",
"url": "<string>"
}
},
"content_type": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_rate": 123,
"http_timeout": 123,
"mtls_client_cert": {
"client_cert": "<string>",
"client_key": "<string>"
},
"name": "<string>",
"owner_id": "<string>",
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
},
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {},
"is_flattened": true
}
},
"function": "<string>",
"name": "<string>",
"project_id": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": 123,
"retry_count": 123
},
"source_metadata": {
"body_function": "<string>",
"created_at": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"deleted_at": "<string>",
"forward_headers": [
"<string>"
],
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"mask_id": "<string>",
"name": "<string>",
"project_id": "<string>",
"provider_config": {
"twitter": {
"crc_verified_at": "<string>"
}
},
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindedExchange": "<string>",
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<string>",
"routingKey": "<string>",
"schema": "<string>",
"vhost": "<string>"
},
"google": {
"project_id": "<string>",
"service_account": [
123
],
"subscription_id": "<string>"
},
"kafka": {
"auth": {
"hash": "<string>",
"password": "<string>",
"tls": true,
"type": "<string>",
"username": "<string>"
},
"brokers": [
"<string>"
],
"consumer_group_id": "<string>",
"topic_name": "<string>"
},
"sqs": {
"access_key_id": "<string>",
"default_region": "<string>",
"endpoint": "<string>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
},
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>",
"verifier": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"hmac": {
"hash": "<string>",
"header": "<string>",
"secret": "<string>"
}
}
},
"uid": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Subscriptions
Update a subscription
This endpoint updates a subscription
PUT
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
Update a subscription
curl --request PUT \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123
},
"source_id": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}"
payload = {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"app_id": "<string>",
"endpoint_id": "<string>",
"filter_config": {
"event_types": ["<string>"],
"filter": {
"body": {},
"headers": {}
}
},
"function": "<string>",
"name": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": "<string>",
"interval_seconds": 123,
"retry_count": 123
},
"source_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
alert_config: {count: 123, threshold: '<string>'},
app_id: '<string>',
endpoint_id: '<string>',
filter_config: {event_types: ['<string>'], filter: {body: JSON.stringify({}), headers: {}}},
function: '<string>',
name: '<string>',
rate_limit_config: {count: 123, duration: 123},
retry_config: {duration: '<string>', interval_seconds: 123, retry_count: 123},
source_id: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}', 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://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'alert_config' => [
'count' => 123,
'threshold' => '<string>'
],
'app_id' => '<string>',
'endpoint_id' => '<string>',
'filter_config' => [
'event_types' => [
'<string>'
],
'filter' => [
'body' => [
],
'headers' => [
]
]
],
'function' => '<string>',
'name' => '<string>',
'rate_limit_config' => [
'count' => 123,
'duration' => 123
],
'retry_config' => [
'duration' => '<string>',
'interval_seconds' => 123,
'retry_count' => 123
],
'source_id' => '<string>'
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}"
payload := strings.NewReader("{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"alert_config\": {\n \"count\": 123,\n \"threshold\": \"<string>\"\n },\n \"app_id\": \"<string>\",\n \"endpoint_id\": \"<string>\",\n \"filter_config\": {\n \"event_types\": [\n \"<string>\"\n ],\n \"filter\": {\n \"body\": {},\n \"headers\": {}\n }\n },\n \"function\": \"<string>\",\n \"name\": \"<string>\",\n \"rate_limit_config\": {\n \"count\": 123,\n \"duration\": 123\n },\n \"retry_config\": {\n \"duration\": \"<string>\",\n \"interval_seconds\": 123,\n \"retry_count\": 123\n },\n \"source_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"alert_config": {
"count": 123,
"threshold": "<string>"
},
"created_at": "<string>",
"deleted_at": "<string>",
"device_metadata": {
"created_at": "<string>",
"deleted_at": "<string>",
"endpoint_id": "<string>",
"host_name": "<string>",
"last_seen_at": "<string>",
"project_id": "<string>",
"uid": "<string>",
"updated_at": "<string>"
},
"endpoint_metadata": {
"advanced_signatures": true,
"authentication": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"oauth2": {
"audience": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"field_mapping": {
"access_token": "<string>",
"expires_in": "<string>",
"token_type": "<string>"
},
"grant_type": "<string>",
"issuer": "<string>",
"scope": "<string>",
"signing_algorithm": "<string>",
"signing_key": {
"crv": "<string>",
"d": "<string>",
"dp": "<string>",
"dq": "<string>",
"e": "<string>",
"kid": "<string>",
"kty": "<string>",
"n": "<string>",
"p": "<string>",
"q": "<string>",
"qi": "<string>",
"x": "<string>",
"y": "<string>"
},
"subject": "<string>",
"url": "<string>"
}
},
"content_type": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_rate": 123,
"http_timeout": 123,
"mtls_client_cert": {
"client_cert": "<string>",
"client_key": "<string>"
},
"name": "<string>",
"owner_id": "<string>",
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
},
"filter_config": {
"event_types": [
"<string>"
],
"filter": {
"body": {},
"headers": {},
"is_flattened": true
}
},
"function": "<string>",
"name": "<string>",
"project_id": "<string>",
"rate_limit_config": {
"count": 123,
"duration": 123
},
"retry_config": {
"duration": 123,
"retry_count": 123
},
"source_metadata": {
"body_function": "<string>",
"created_at": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"deleted_at": "<string>",
"forward_headers": [
"<string>"
],
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"mask_id": "<string>",
"name": "<string>",
"project_id": "<string>",
"provider_config": {
"twitter": {
"crc_verified_at": "<string>"
}
},
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindedExchange": "<string>",
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<string>",
"routingKey": "<string>",
"schema": "<string>",
"vhost": "<string>"
},
"google": {
"project_id": "<string>",
"service_account": [
123
],
"subscription_id": "<string>"
},
"kafka": {
"auth": {
"hash": "<string>",
"password": "<string>",
"tls": true,
"type": "<string>",
"username": "<string>"
},
"brokers": [
"<string>"
],
"consumer_group_id": "<string>",
"topic_name": "<string>"
},
"sqs": {
"access_key_id": "<string>",
"default_region": "<string>",
"endpoint": "<string>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
},
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>",
"verifier": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"hmac": {
"hash": "<string>",
"header": "<string>",
"secret": "<string>"
}
}
},
"uid": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Authorizations
Body
application/json
Subscription Details
Alert configuration
Show child attributes
Show child attributes
Deprecated but necessary for backward compatibility
Delivery mode configuration
Available options:
at_least_once, at_most_once Destination endpoint ID
Filter configuration
Show child attributes
Show child attributes
Convoy supports mutating your request payload using a js function. Use this field
to specify a transform function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more
Subscription Nme
Rate limit configuration
Show child attributes
Show child attributes
Retry configuration
Show child attributes
Show child attributes
Source Id
Was this page helpful?
⌘I