Create a record view

curl --request POST \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/record-views \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "dataset": "<string>",
  "name": "<string>",
  "columns": [
    "<string>"
  ],
  "sort_key": "<string>",
  "sort_dir": "desc",
  "is_default": false,
  "portal_shared": true
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset: '<string>',
    name: '<string>',
    columns: ['<string>'],
    sort_key: '<string>',
    sort_dir: 'desc',
    is_default: false,
    portal_shared: true
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/record-views', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/record-views"

payload = {
    "dataset": "<string>",
    "name": "<string>",
    "columns": ["<string>"],
    "sort_key": "<string>",
    "sort_dir": "desc",
    "is_default": False,
    "portal_shared": True
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "view": {
    "id": "<string>",
    "dataset": "<string>",
    "name": "<string>",
    "columns": [
      {
        "key": "<string>",
        "label": "<string>"
      }
    ],
    "sort_key": "<string>",
    "sort_dir": "asc",
    "is_default": true,
    "portal_shared": true
  }
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

POST

admin

api

projects

{project_id}

record-views

Create a record view

curl --request POST \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/record-views \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "dataset": "<string>",
  "name": "<string>",
  "columns": [
    "<string>"
  ],
  "sort_key": "<string>",
  "sort_dir": "desc",
  "is_default": false,
  "portal_shared": true
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset: '<string>',
    name: '<string>',
    columns: ['<string>'],
    sort_key: '<string>',
    sort_dir: 'desc',
    is_default: false,
    portal_shared: true
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/record-views', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/record-views"

payload = {
    "dataset": "<string>",
    "name": "<string>",
    "columns": ["<string>"],
    "sort_key": "<string>",
    "sort_dir": "desc",
    "is_default": False,
    "portal_shared": True
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "view": {
    "id": "<string>",
    "dataset": "<string>",
    "name": "<string>",
    "columns": [
      {
        "key": "<string>",
        "label": "<string>"
      }
    ],
    "sort_key": "<string>",
    "sort_dir": "asc",
    "is_default": true,
    "portal_shared": true
  }
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

Authorizations

hookie_session

string

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

project_id

string

required

Project id (UUID) belonging to the caller workspace.

Body

application/json

dataset

string

required

The dataset this view reads (a valid dataset name). Sending webhook_id instead is a 400 that says so.

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.

portal_shared

boolean

Share this view with the project's portal customer (#376, read-only). A project is one customer's space with one portal, so this is a flag: the customer sees this view's columns over the project's rows of the dataset, provided the portal exposes it. Default false (private).

Response

Created. The echoed view uses the same snake_case keys as the list (id, dataset, name, columns, sort_key, sort_dir, is_default).

view

object

required

Show child attributes

Get started

Concepts

CLI

Guides

API reference

Create a record view

Authorizations

Headers

Path Parameters

Body

Response