Create a source
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"body_function": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"event_type_location": "<string>",
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"name": "<string>",
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<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>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
}
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources"
payload = {
"body_function": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"event_type_location": "<string>",
"header_function": "<string>",
"idempotency_keys": ["<string>"],
"name": "<string>",
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<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>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
}
}
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({
body_function: '<string>',
custom_response: {body: JSON.stringify('<string>'), content_type: '<string>'},
event_type_location: '<string>',
header_function: '<string>',
idempotency_keys: ['<string>'],
name: '<string>',
pub_sub: {
amqp: {
host: '<string>',
auth: {password: '<string>', user: '<string>'},
bindExchange: {exchange: '<string>', routingKey: '<string>'},
deadLetterExchange: '<string>',
port: '<string>',
queue: '<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>',
queue_name: '<string>',
secret_key: '<string>'
},
workers: 123
}
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources', 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}/sources",
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([
'body_function' => '<string>',
'custom_response' => [
'body' => '<string>',
'content_type' => '<string>'
],
'event_type_location' => '<string>',
'header_function' => '<string>',
'idempotency_keys' => [
'<string>'
],
'name' => '<string>',
'pub_sub' => [
'amqp' => [
'host' => '<string>',
'auth' => [
'password' => '<string>',
'user' => '<string>'
],
'bindExchange' => [
'exchange' => '<string>',
'routingKey' => '<string>'
],
'deadLetterExchange' => '<string>',
'port' => '<string>',
'queue' => '<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>',
'queue_name' => '<string>',
'secret_key' => '<string>'
],
'workers' => 123
]
]),
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}/sources"
payload := strings.NewReader("{\n \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\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}/sources")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources")
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 \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"body_function": "<string>",
"created_at": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"deleted_at": "<string>",
"event_type_location": "<string>",
"forward_headers": [
"<string>"
],
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"mask_id": "<string>",
"name": "<string>",
"project_id": "<string>",
"provider": "github",
"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>"
},
"type": "sqs",
"workers": 123
},
"type": "http",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>",
"verifier": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"hmac": {
"encoding": "base64",
"hash": "<string>",
"header": "<string>",
"secret": "<string>"
},
"type": "noop"
}
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Sources
Create a source
This endpoint creates a source
POST
/
v1
/
projects
/
{projectID}
/
sources
Create a source
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"body_function": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"event_type_location": "<string>",
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"name": "<string>",
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<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>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
}
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources"
payload = {
"body_function": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"event_type_location": "<string>",
"header_function": "<string>",
"idempotency_keys": ["<string>"],
"name": "<string>",
"pub_sub": {
"amqp": {
"host": "<string>",
"auth": {
"password": "<string>",
"user": "<string>"
},
"bindExchange": {
"exchange": "<string>",
"routingKey": "<string>"
},
"deadLetterExchange": "<string>",
"port": "<string>",
"queue": "<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>",
"queue_name": "<string>",
"secret_key": "<string>"
},
"workers": 123
}
}
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({
body_function: '<string>',
custom_response: {body: JSON.stringify('<string>'), content_type: '<string>'},
event_type_location: '<string>',
header_function: '<string>',
idempotency_keys: ['<string>'],
name: '<string>',
pub_sub: {
amqp: {
host: '<string>',
auth: {password: '<string>', user: '<string>'},
bindExchange: {exchange: '<string>', routingKey: '<string>'},
deadLetterExchange: '<string>',
port: '<string>',
queue: '<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>',
queue_name: '<string>',
secret_key: '<string>'
},
workers: 123
}
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources', 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}/sources",
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([
'body_function' => '<string>',
'custom_response' => [
'body' => '<string>',
'content_type' => '<string>'
],
'event_type_location' => '<string>',
'header_function' => '<string>',
'idempotency_keys' => [
'<string>'
],
'name' => '<string>',
'pub_sub' => [
'amqp' => [
'host' => '<string>',
'auth' => [
'password' => '<string>',
'user' => '<string>'
],
'bindExchange' => [
'exchange' => '<string>',
'routingKey' => '<string>'
],
'deadLetterExchange' => '<string>',
'port' => '<string>',
'queue' => '<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>',
'queue_name' => '<string>',
'secret_key' => '<string>'
],
'workers' => 123
]
]),
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}/sources"
payload := strings.NewReader("{\n \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\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}/sources")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/sources")
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 \"body_function\": \"<string>\",\n \"custom_response\": {\n \"body\": \"<string>\",\n \"content_type\": \"<string>\"\n },\n \"event_type_location\": \"<string>\",\n \"header_function\": \"<string>\",\n \"idempotency_keys\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"pub_sub\": {\n \"amqp\": {\n \"host\": \"<string>\",\n \"auth\": {\n \"password\": \"<string>\",\n \"user\": \"<string>\"\n },\n \"bindExchange\": {\n \"exchange\": \"<string>\",\n \"routingKey\": \"<string>\"\n },\n \"deadLetterExchange\": \"<string>\",\n \"port\": \"<string>\",\n \"queue\": \"<string>\",\n \"schema\": \"<string>\",\n \"vhost\": \"<string>\"\n },\n \"google\": {\n \"project_id\": \"<string>\",\n \"service_account\": [\n 123\n ],\n \"subscription_id\": \"<string>\"\n },\n \"kafka\": {\n \"auth\": {\n \"hash\": \"<string>\",\n \"password\": \"<string>\",\n \"tls\": true,\n \"type\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"brokers\": [\n \"<string>\"\n ],\n \"consumer_group_id\": \"<string>\",\n \"topic_name\": \"<string>\"\n },\n \"sqs\": {\n \"access_key_id\": \"<string>\",\n \"default_region\": \"<string>\",\n \"queue_name\": \"<string>\",\n \"secret_key\": \"<string>\"\n },\n \"workers\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"body_function": "<string>",
"created_at": "<string>",
"custom_response": {
"body": "<string>",
"content_type": "<string>"
},
"deleted_at": "<string>",
"event_type_location": "<string>",
"forward_headers": [
"<string>"
],
"header_function": "<string>",
"idempotency_keys": [
"<string>"
],
"is_disabled": true,
"mask_id": "<string>",
"name": "<string>",
"project_id": "<string>",
"provider": "github",
"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>"
},
"type": "sqs",
"workers": 123
},
"type": "http",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>",
"verifier": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"basic_auth": {
"password": "<string>",
"username": "<string>"
},
"hmac": {
"encoding": "base64",
"hash": "<string>",
"header": "<string>",
"secret": "<string>"
},
"type": "noop"
}
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Authorizations
Path Parameters
Project ID
Body
application/json
Source Details
Function is a javascript function used to mutate the payload immediately after ingesting an event
Custom response is used to define a custom response for incoming webhooks project sources only.
Show child attributes
Show child attributes
EventTypeLocation is used to specify where Convoy should read the event type from an incoming webhook request.
Function is a javascript function used to mutate the headers immediately after ingesting an event
IdempotencyKeys are used to specify parts of a webhook request to uniquely identify the event in an incoming webhooks project.
Source name.
Use this to specify one of our predefined source types.
Available options:
github, twitter, shopify PubSub are used to specify message broker sources for outgoing webhooks projects.
Show child attributes
Show child attributes
Source Type.
Available options:
http, rest_api, pub_sub, db_change_stream Verifiers are used to verify webhook events ingested in incoming webhooks projects. If set, type is required and match the verifier type object you choose.
Show child attributes
Show child attributes
Was this page helpful?