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

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

event_types
string[]

A list of event types for the subscription filter config

idempotency_key
string

Specify a key for event deduplication

secret
string

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

url
string

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

Response

200 - application/json

The response is of type object.

Was this page helpful?

Batch replay eventsFan out an event