Events

Create an event

This endpoint creates an endpoint event 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

Path parameters

projectIDstring required

Project ID

Request body

app_idstring

Deprecated but necessary for backward compatibility.

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

endpoint_idstring

Specifies the endpoint to send this event to. Required unless the deprecated app_id is provided.

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

Changed in 13 of the 69 revisions of this API.134741

Aug 27, 2026v3df004d06c6c214See the full diff
- ▲
  the allOf[subschema #2]/data response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ○
  added the optional property allOf[subschema #2]/data/event_type to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/idempotency_key to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/uid to the response with the 201 status
  response-optional-property-added
- ○
  removed handlers.Stub from the allOf[subschema #2]/data response property allOf list for the response status 201
  response-property-all-of-removed
Jul 20, 2026v3bae289777c9186See the full diff
- ▲
  the response property allOf[subschema #2]/data became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data became nullable for the status 401
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/data became nullable for the status 404
  response-property-became-nullable
- ▲
  the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 400
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 401
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 404
  response-property-type-changed
- ○
  the request property custom_headers became nullable
  request-property-became-nullable
- ○
  the request property data became nullable
  request-property-became-nullable
- ○
  added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 201
  response-property-all-of-added
- ○
  added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 400
  response-property-all-of-added
- ○
  added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 401
  response-property-all-of-added
- ○
  added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 404
  response-property-all-of-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 12, 2024v359336767e79a11See 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
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 2024v328d285e4302c1213See the full diff
- ▲
  the data request property type/format changed from array/ to object/
  request-property-type-changed
- ●
  removed the optional property allOf[util.ServerResponse]/data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[util.ServerResponse]/data from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property allOf[util.ServerResponse]/data from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[util.ServerResponse]/data from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/app_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/created_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/deleted_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/endpoint_metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/endpoints from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/event_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/headers from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/idempotency_key from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/is_duplicate_event from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/project_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/raw from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/source_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/source_metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/uid from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/updated_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/url_query_params from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id CreateEndpointEvent was added
  api-operation-id-added
- ○
  added the new optional request property app_id
  new-optional-request-property
- ○
  added the new optional request property endpoint_id
  new-optional-request-property
Feb 20, 2024v39e4b97e26a2a17See the full diff
- ○
  added the optional property allOf[subschema #2]/data/app_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/deleted_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/endpoint_metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/endpoints to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/event_type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/headers to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/idempotency_key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/is_duplicate_event to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/project_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/raw to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/source_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/source_metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/uid to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/url_query_params to the response with the 200 status
  response-optional-property-added
Feb 20, 2024v36ef49682c1c017See the full diff
- ●
  removed the optional property allOf[subschema #2]/data/app_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/created_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/deleted_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/endpoint_metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/endpoints from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/event_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/headers from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/idempotency_key from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/is_duplicate_event from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/project_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/raw from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/source_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/source_metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/uid from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/updated_at from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/data/url_query_params from the response with the 200 status
  response-optional-property-removed
Feb 13, 2024v3182c7b00a49a3See the full diff
- ●
  removed the request property app_id
  request-property-removed
- ●
  removed the request property endpoint_id
  request-property-removed
- ●
  removed the request property owner_id
  request-property-removed
Feb 8, 2024v38aa5161aec4c11See the full diff
- ●
  added the new amqp enum value to the allOf[subschema #2]/data/source_metadata/pub_sub/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property allOf[subschema #2]/data/source_metadata/pub_sub/amqp to the response with the 200 status
  response-optional-property-added
Jan 31, 2024v34358c29a505b1See the full diff
- ●
  removed the request property uid
  request-property-removed
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 30, 2024v3a138f74e9d232See the full diff
- ▲
  the allOf[subschema #2]/data/endpoint_metadata/items/http_timeout response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/data/endpoint_metadata/items/rate_limit_duration response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (13 revisions)