Skip to main content
POST
Test conditions and mappings against a sample payload

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.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json
payload
any
required

The sample event.

conditions
object[]
Maximum array length: 10
mappings
object[]

Response

The verdict.

matched
boolean
required
record
object | null
required

What the rule would store; null when it does not match.