Create a broadcast event
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"acknowledged_at": "<string>",
"custom_headers": {},
"data": {},
"event_type": "<string>",
"idempotency_key": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast"
payload = {
"acknowledged_at": "<string>",
"custom_headers": {},
"data": {},
"event_type": "<string>",
"idempotency_key": "<string>"
}
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({
acknowledged_at: '<string>',
custom_headers: {},
data: {},
event_type: '<string>',
idempotency_key: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast', 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}/events/broadcast",
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([
'acknowledged_at' => '<string>',
'custom_headers' => [
],
'data' => [
],
'event_type' => '<string>',
'idempotency_key' => '<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}/events/broadcast"
payload := strings.NewReader("{\n \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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}/events/broadcast")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast")
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 \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"acknowledged_at": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"data": [
123
],
"deleted_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>"
}
},
"cb_state": "<string>",
"content_type": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_count": 123,
"failure_rate": 123,
"http_timeout": 123,
"mtls_client_cert": {
"client_cert": "<string>",
"client_key": "<string>"
},
"name": "<string>",
"owner_id": "<string>",
"period_failure_rate": 123,
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"retry_count": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"success_count": 123,
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"endpoints": [
"<string>"
],
"event_type": "<string>",
"headers": {},
"idempotency_key": "<string>",
"is_duplicate_event": true,
"metadata": "<string>",
"project_id": "<string>",
"raw": "<string>",
"source_id": "<string>",
"source_metadata": {
"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_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>",
"url_path": "<string>",
"url_query_params": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Events
Create a broadcast event
This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.
POST
/
v1
/
projects
/
{projectID}
/
events
/
broadcast
Create a broadcast event
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"acknowledged_at": "<string>",
"custom_headers": {},
"data": {},
"event_type": "<string>",
"idempotency_key": "<string>"
}
'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast"
payload = {
"acknowledged_at": "<string>",
"custom_headers": {},
"data": {},
"event_type": "<string>",
"idempotency_key": "<string>"
}
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({
acknowledged_at: '<string>',
custom_headers: {},
data: {},
event_type: '<string>',
idempotency_key: '<string>'
})
};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast', 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}/events/broadcast",
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([
'acknowledged_at' => '<string>',
'custom_headers' => [
],
'data' => [
],
'event_type' => '<string>',
'idempotency_key' => '<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}/events/broadcast"
payload := strings.NewReader("{\n \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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}/events/broadcast")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/events/broadcast")
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 \"acknowledged_at\": \"<string>\",\n \"custom_headers\": {},\n \"data\": {},\n \"event_type\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"acknowledged_at": "<string>",
"app_id": "<string>",
"created_at": "<string>",
"data": [
123
],
"deleted_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>"
}
},
"cb_state": "<string>",
"content_type": "<string>",
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_count": 123,
"failure_rate": 123,
"http_timeout": 123,
"mtls_client_cert": {
"client_cert": "<string>",
"client_key": "<string>"
},
"name": "<string>",
"owner_id": "<string>",
"period_failure_rate": 123,
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"retry_count": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"success_count": 123,
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"endpoints": [
"<string>"
],
"event_type": "<string>",
"headers": {},
"idempotency_key": "<string>",
"is_duplicate_event": true,
"metadata": "<string>",
"project_id": "<string>",
"raw": "<string>",
"source_id": "<string>",
"source_metadata": {
"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_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>",
"url_path": "<string>",
"url_query_params": "<string>"
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Authorizations
Path Parameters
Project ID
Body
application/json
Broadcast Event Details
Specifies custom headers you want convoy to add when the event is dispatched to your endpoint
Show child attributes
Show child attributes
Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
Event Type is used for filtering and debugging e.g invoice.paid
Specify a key for event deduplication
Was this page helpful?
⌘I