Skip to main content
POST
Create a mapping rule

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json
name
string
required

Trimmed before storing; must be non-empty and at most 80 characters.

Required string length: 1 - 80
dataset
string
required

The logical table matched events land in.

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,62}$
enabled
boolean
default:true

Anything other than the literal false is treated as true.

conditions
object[]

Omitted, null or empty means match every event. All conditions must hold.

Maximum array length: 10
mappings
object[]

Omitted, null or empty means identity - store the whole payload.

Maximum array length: 50

Response

Created.

id
string
required