FRfrain-dev
Events

Create a broadcast event

Changed on

This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type. The 201 body includes uid (the event id). Use GET /events/{eventID} or GET /eventdeliveries?eventId= to follow the send.

post/v1/projects/{projectID}/events/broadcast

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

Request body

acknowledged_atstring
custom_headersobject nullable

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

dataobject nullable

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

Response

Created

messagestring
statusboolean

Changes