Meta Events
Retrieve a meta event
- 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
Retrieve a meta event
This endpoint retrieves a meta event
GET
/
v1
/
projects
/
{projectID}
/
meta-events
/
{metaEventID}
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
metaEventID
string
*
metaEventID
Required
string
meta event id
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/meta-events/{metaEventID} \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"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>"
}
}
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
metaEventID
string
requiredmeta event id
Response
200 - application/json
message
string
status
boolean
data
object
data.attempt
object
data.attempt.request_http_header
object
data.attempt.response_data
string
data.attempt.response_http_header
object
data.created_at
string
data.deleted_at
string
data.event_type
string
data.metadata
object
data.metadata.data
integer[]
Data to be sent to endpoint.
data.metadata.interval_seconds
integer
data.metadata.next_send_time
string
data.metadata.num_trials
integer
NumTrials: number of times we have tried to deliver this Event to an application
data.metadata.raw
string
data.metadata.retry_limit
integer
data.metadata.strategy
enum<string>
Available options:
linear
, exponential
data.project_id
string
data.status
enum<string>
Available options:
Scheduled
, Processing
, Discarded
, Failure
, Success
, Retry
data.uid
string
data.updated_at
string
Was this page helpful?
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/meta-events/{metaEventID} \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"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>"
}
}