Events
Create a broadcast event
This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type.
POST
/
v1
/
projects
/
{projectID}
/
events
/
broadcast
Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
Body
application/json
acknowledged_at
string
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
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
201 - application/json
message
string
status
boolean
data
object
Was this page helpful?