Meta Events
List all meta events
- Community
- GitHub
- Tutorials
- GETList all endpoints
- POSTCreate an endpoint
- GETRetrieve endpoint
- PUTUpdate an endpoint
- DELDelete endpoint
- PUTRoll endpoint secret
- PUTPause endpoint
- GETList all event deliveries
- POSTBatch retry event delivery
- POSTForce retry event delivery
- GETRetrieve an event delivery
- PUTRetry event delivery
- GETList all events
- POSTCreate an event
- POSTCreate a broadcast event
- POSTBatch replay events
- POSTDynamic Events
- POSTFan out an event
- GETRetrieve an event
- PUTReplay event
- GETList all portal links
- POSTCreate a portal link
- GETRetrieve a portal link
- PUTUpdate a portal link
- PUTRevoke a portal link
Endpoints
Event Deliveries
Events
Portal Links
Meta Events
List all meta events
This endpoint fetches meta events with pagination
GET
/
v1
/
projects
/
{projectID}
/
meta-events
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
direction
enum<string>
direction
enum<string>
endDate
string
endDate
string
The end date
next_page_cursor
string
next_page_cursor
string
A pagination cursor to fetch the next page of a list
perPage
integer
perPage
integer
The number of items to return per page
prev_page_cursor
string
prev_page_cursor
string
A pagination cursor to fetch the previous page of a list
sort
string
sort
string
Sort order, values are ASC
or DESC
, defaults to DESC
startDate
string
startDate
string
The start date
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/meta-events \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"attempt": {
"request_http_header": {},
"response_data": "<string>",
"response_http_header": {}
},
"created_at": "<string>",
"deleted_at": "<string>",
"event_type": "<string>",
"metadata": {
"data": [
123
],
"interval_seconds": 123,
"next_send_time": "<string>",
"num_trials": 123,
"raw": "<string>",
"retry_limit": 123,
"strategy": "linear"
},
"project_id": "<string>",
"status": "Scheduled",
"uid": "<string>",
"updated_at": "<string>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>"
}
}
}
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
Query Parameters
direction
enum<string>
Available options:
next
, prev
endDate
string
The end date
next_page_cursor
string
A pagination cursor to fetch the next page of a list
perPage
integer
The number of items to return per page
prev_page_cursor
string
A pagination cursor to fetch the previous page of a list
sort
string
Sort order, values are ASC
or DESC
, defaults to DESC
startDate
string
The start date
Response
200 - application/json
message
string
status
boolean
data
object
data.content
object[]
data.content.attempt
object
data.content.attempt.request_http_header
object
data.content.attempt.response_data
string
data.content.attempt.response_http_header
object
data.content.created_at
string
data.content.deleted_at
string
data.content.event_type
string
data.content.metadata
object
data.content.metadata.data
integer[]
Data to be sent to endpoint.
data.content.metadata.interval_seconds
integer
data.content.metadata.next_send_time
string
data.content.metadata.num_trials
integer
NumTrials: number of times we have tried to deliver this Event to an application
data.content.metadata.raw
string
data.content.metadata.retry_limit
integer
data.content.metadata.strategy
enum<string>
Available options:
linear
, exponential
data.content.project_id
string
data.content.status
enum<string>
Available options:
Scheduled
, Processing
, Discarded
, Failure
, Success
, Retry
data.content.uid
string
data.content.updated_at
string
data.pagination
object
data.pagination.has_next_page
boolean
data.pagination.has_prev_page
boolean
data.pagination.next_page_cursor
string
data.pagination.per_page
integer
data.pagination.prev_page_cursor
string
Was this page helpful?
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/meta-events \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"attempt": {
"request_http_header": {},
"response_data": "<string>",
"response_http_header": {}
},
"created_at": "<string>",
"deleted_at": "<string>",
"event_type": "<string>",
"metadata": {
"data": [
123
],
"interval_seconds": 123,
"next_send_time": "<string>",
"num_trials": 123,
"raw": "<string>",
"retry_limit": 123,
"strategy": "linear"
},
"project_id": "<string>",
"status": "Scheduled",
"uid": "<string>",
"updated_at": "<string>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>"
}
}
}