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

Path parameters

projectIDstring required

Project ID

custom_headersobject

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

datainteger[]

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

event_typestring

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

idempotency_keystring

Specify a key for event deduplication

messagestring

statusboolean