POST
/
v1
/
projects
/
{projectID}
/
events
curl --request POST \
  --url https://dashboard.getconvoy.io/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": {}
}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

Body

application/json
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

200 - application/json
message
string
status
boolean
data
object

Was this page helpful?

List all eventsCreate a broadcast event