POST
/
v1
/
projects
/
{projectID}
/
event-types
Create an event type
curl --request POST \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/event-types \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "category": "<string>",
  "description": "<string>",
  "name": "<string>"
}'
{
  "message": "<string>",
  "status": true,
  "data": {
    "event_type": {
      "category": "<string>",
      "deprecated_at": "<string>",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

projectID
string
required

Project ID

Body

application/json

Event Type Details

category
string

Category is a product-specific grouping for the event type

description
string

Description is used to describe what the event type does

name
string

Name is the event type name. E.g., invoice.created

Response

Created

message
string
status
boolean
data
object