Validate subscription filter
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"request": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
},
"schema": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
}
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter"
payload = {
"request": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
},
"schema": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request: {
body: JSON.stringify('<unknown>'),
header: '<unknown>',
path: '<unknown>',
query: '<unknown>'
},
schema: {
body: JSON.stringify('<unknown>'),
header: '<unknown>',
path: '<unknown>',
query: '<unknown>'
}
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter', 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/test_filter",
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([
'request' => [
'body' => '<unknown>',
'header' => '<unknown>',
'path' => '<unknown>',
'query' => '<unknown>'
],
'schema' => [
'body' => '<unknown>',
'header' => '<unknown>',
'path' => '<unknown>',
'query' => '<unknown>'
]
]),
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/test_filter"
payload := strings.NewReader("{\n \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\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://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter")
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 \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": true
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Subscriptions
Validate subscription filter
This endpoint validates that a filter will match a certain payload structure.
POST
/
v1
/
projects
/
{projectID}
/
subscriptions
/
test_filter
Validate subscription filter
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"request": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
},
"schema": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
}
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter"
payload = {
"request": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
},
"schema": {
"body": "<unknown>",
"header": "<unknown>",
"path": "<unknown>",
"query": "<unknown>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request: {
body: JSON.stringify('<unknown>'),
header: '<unknown>',
path: '<unknown>',
query: '<unknown>'
},
schema: {
body: JSON.stringify('<unknown>'),
header: '<unknown>',
path: '<unknown>',
query: '<unknown>'
}
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter', 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/test_filter",
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([
'request' => [
'body' => '<unknown>',
'header' => '<unknown>',
'path' => '<unknown>',
'query' => '<unknown>'
],
'schema' => [
'body' => '<unknown>',
'header' => '<unknown>',
'path' => '<unknown>',
'query' => '<unknown>'
]
]),
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/test_filter"
payload := strings.NewReader("{\n \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\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://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/test_filter")
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 \"request\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n },\n \"schema\": {\n \"body\": \"<unknown>\",\n \"header\": \"<unknown>\",\n \"path\": \"<unknown>\",\n \"query\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": true
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Was this page helpful?
⌘I