List all event deliveries
curl --request GET \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries \
--header 'Authorization: <api-key>'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries', 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}/eventdeliveries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"acknowledged_at": "<string>",
"cli_metadata": {
"event_type": "<string>",
"source_id": "<string>"
},
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"device_id": "<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_id": "<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>"
},
"event_id": "<string>",
"event_metadata": {
"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>"
},
"event_type": "<string>",
"headers": {},
"idempotency_key": "<string>",
"latency": "<string>",
"latency_seconds": 123,
"metadata": {
"data": [
123
],
"interval_seconds": 123,
"max_retry_seconds": 123,
"next_send_time": "<string>",
"num_trials": 123,
"raw": "<string>",
"retry_limit": 123
},
"project_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>"
}
}
},
"subscription_id": "<string>",
"target_url": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url_query_params": "<string>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>",
"total": 123
}
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Event Deliveries
List all event deliveries
This endpoint retrieves all event deliveries paginated.
GET
/
v1
/
projects
/
{projectID}
/
eventdeliveries
List all event deliveries
curl --request GET \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries \
--header 'Authorization: <api-key>'import requests
url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries', 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}/eventdeliveries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/eventdeliveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"acknowledged_at": "<string>",
"cli_metadata": {
"event_type": "<string>",
"source_id": "<string>"
},
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"device_id": "<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_id": "<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>"
},
"event_id": "<string>",
"event_metadata": {
"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>"
},
"event_type": "<string>",
"headers": {},
"idempotency_key": "<string>",
"latency": "<string>",
"latency_seconds": 123,
"metadata": {
"data": [
123
],
"interval_seconds": 123,
"max_retry_seconds": 123,
"next_send_time": "<string>",
"num_trials": 123,
"raw": "<string>",
"retry_limit": 123
},
"project_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>"
}
}
},
"subscription_id": "<string>",
"target_url": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url_query_params": "<string>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>",
"total": 123
}
}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}{
"message": "<string>",
"status": true,
"data": {}
}Authorizations
Path Parameters
Project ID
Query Parameters
Available options:
next, prev The end date
A list of endpoint IDs to filter by
Event ID to filter by
EventType to filter by
IdempotencyKey to filter by
A pagination cursor to fetch the next page of a list
The number of items to return per page
A pagination cursor to fetch the previous page of a list
Sort order, values are ASC or DESC, defaults to DESC
The start date
A list of event delivery statuses to filter by
SubscriptionID to filter by
Was this page helpful?
⌘I