Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
events
Create an event
curl --request POST \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": "<string>",
  "custom_headers": {},
  "data": {},
  "endpoint_id": "<string>",
  "event_type": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "message": "<string>",
  "status": true,
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://getconvoy.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

Body

application/json

Event Details

​
app_id
string

Deprecated but necessary for backward compatibility.

​
custom_headers
object

Specifies custom headers you want convoy to add when the event is dispatched to your endpoint

​
data
object

Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints

​
endpoint_id
string

Specifies the endpoint to send this event to.

​
event_type
string

Event Type is used for filtering and debugging e.g invoice.paid

​
idempotency_key
string

Specify a key for event deduplication

Response

Created

​
message
string
​
status
boolean
​
data
object