Sign in
Events

Fan out an event

This endpoint uses the owner_id to fan out an event to multiple endpoints. 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/fanout

Path parameters

projectIDstring required

Project ID

Request body

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

owner_idstring

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

Response

Created

messagestring
statusboolean

Changes

Changed in 3 of the 60 revisions of this API.24

  • b00279e91a8211See the full diff
    • ▲

      removed the success response with the status 200

      response-success-status-removed

    • ○

      added the success response with the status 201

      response-success-status-added

  • 2ddfad6467921See the full diff
    • ○

      api operation id CreateEndpointFanoutEvent was added

      api-operation-id-added

  • 5a219dba9f4012See the full diff
    • ▲

      removed the success response with the status 201

      response-success-status-removed

    • ○

      api operation id CreateEndpointFanoutEvent removed and replaced with

      api-operation-id-removed

    • ○

      added the success response with the status 200

      response-success-status-added