POST
/
v1
/
projects
/
{projectID}
/
events
/
fanout
curl --request POST \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/events/fanout \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_headers": {},
  "data": [
    123
  ],
  "event_type": "<string>",
  "idempotency_key": "<string>",
  "owner_id": "<string>"
}'
{
  "message": "<string>",
  "status": true,
  "data": {}
}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

Body

application/json
custom_headers
object

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

data
integer[]

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

owner_id
string

Used for fanout, sends this event to all endpoints with this OwnerID.

Response

200 - application/json
message
string
status
boolean
data
object

Was this page helpful?

Dynamic EventsRetrieve an event