latestOpenAPI 3.0.0Mozilla Public License 2.0raw.githubusercontent.com2026-08-2068152428.8 KB

8b507b40f18d

Events

Dynamic Events

This endpoint does not require creating endpoint and subscriptions ahead of time. Instead, you supply the endpoint and the payload, and Convoy delivers the events

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

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

event_typesstring[]

A list of event types for the subscription filter config

idempotency_keystring

Specify a key for event deduplication

secretstring

Endpoint's webhook secret. If not provided, Convoy autogenerates one for the endpoint.

urlstring

URL is the endpoint's URL prefixed with https. non-https urls are currently not supported.

Response

Created

messagestring

statusboolean

dataHandlersStub nullable