Skip to main content
PUT
Define an event type

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

type
string
required

Lower-case words joined by dots, such as real_estate.visit_booked.

Maximum string length: 64
Pattern: ^[a-z0-9_]+(\.[a-z0-9_]+)+$

Body

application/json
name
string
Maximum string length: 255
description
string
Maximum string length: 255
schema
object | null

What POST /v1/events checks properties against.

Response

Replaced.

type
string
Example:

"real_estate.visit_booked"

name
string | null
description
string | null
schema
object | null

What POST /v1/events checks properties against.

archived
boolean
archived_at
string<date-time> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null