Skip to main content
POST
Create a record view

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
webhook_id
string
required

Must name a webhook in this project.

name
string
required
Required string length: 1 - 80
columns
(string | object)[]
required

Payload keys, or the meta columns _id, _received_at, _source. Keys must be unique; a bare string is shorthand for {key, label:key}.

Required array length: 1 - 40 elements
Maximum string length: 128
sort_key
string | null

A column key to sort by, or null/empty for arrival order. Must satisfy the same key rules.

sort_dir
enum<string>
default:desc

Any value other than asc is stored as desc.

Available options:
asc,
desc
is_default
boolean
default:false

Only the literal true counts. Setting it clears the default flag on every other view of the same webhook in the same batch.

Response

Created. Note the echoed view uses the internal camelCase spec field names sortKey, sortDir and isDefault - NOT the snake_case names returned by the list endpoint.

view
object
required