> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a record view

> Top-level alias: POST /admin/api/record-views. Write role required.



## OpenAPI

````yaml /openapi.json post /admin/api/projects/{pid}/record-views
openapi: 3.1.0
info:
  title: Hookie API
  version: 1.0.0
  summary: Capture, route and deliver webhooks.
  description: >-
    Hookie exposes three HTTP surfaces.


    **Ingest + streaming** is the public plane. A path-form endpoint URL
    authenticates by its own high-entropy slug — there is no key, token or
    cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes.
    Whenever the URL names a dataset the payload is stored whole into it;
    project mapping rules are evaluated on exactly one shape, `POST
    /v1/ingest/{ingest_key}` with no dataset segment.


    **The customer portal API** is a separate, token-authed surface for your end
    customers, scoped to one portal and one customer.


    **The admin API** drives the console. It accepts either a browser session or
    an OAuth bearer token from a connected coding agent — the same routes, the
    same validation, the same audit trail. An agent's authority is its user's
    workspace role narrowed to the scopes granted in the console.


    This document is generated from the request handlers and adversarially
    verified against them.
  contact:
    name: Hookie
    url: https://hookie.ai
  license:
    name: Proprietary
    url: https://hookie.ai/legal/terms
servers:
  - url: https://app.hookie.ai
    description: Production
  - url: https://app.preview.hookie.ai
    description: Preview
security: []
tags:
  - name: Ingest
    description: Send events to Hookie.
  - name: Streaming
    description: Tail events in real time over SSE or WebSocket.
  - name: Portal
    description: Token-authed surface for your end customers.
  - name: Projects
    description: Projects and their settings.
  - name: Routing
    description: Rules, endpoints, datasets and records.
  - name: Delivery
    description: Destinations, deliveries and replay.
  - name: Workflows
    description: Multi-step workflows, triggers and AI agents.
  - name: Observability
    description: Search, correlation, stats and the audit log.
  - name: Workspace
    description: Members, connected agents, SSO and billing.
paths:
  /admin/api/projects/{pid}/record-views:
    post:
      tags:
        - Record views
      summary: Create a record view
      description: 'Top-level alias: POST /admin/api/record-views. Write role required.'
      operationId: createRecordView
      parameters:
        - name: pid
          in: path
          required: true
          description: Project id (UUID) belonging to the caller workspace.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - webhook_id
                - name
                - columns
              properties:
                webhook_id:
                  type: string
                  description: Must name a webhook in this project.
                name:
                  type: string
                  minLength: 1
                  maxLength: 80
                columns:
                  type: array
                  minItems: 1
                  maxItems: 40
                  description: >-
                    Payload keys, or the meta columns _id, _received_at,
                    _source. Keys must be unique; a bare string is shorthand for
                    {key, label:key}.
                  items:
                    oneOf:
                      - type: string
                        maxLength: 128
                      - type: object
                        required:
                          - key
                        properties:
                          key:
                            type: string
                            maxLength: 128
                            description: >-
                              Trimmed, non-empty, no double quotes, backslashes
                              or control characters.
                          label:
                            type: string
                            maxLength: 80
                            description: >-
                              Defaults to the key; longer labels are truncated
                              to 80 characters.
                sort_key:
                  type:
                    - string
                    - 'null'
                  description: >-
                    A column key to sort by, or null/empty for arrival order.
                    Must satisfy the same key rules.
                sort_dir:
                  type: string
                  enum:
                    - asc
                    - desc
                  default: desc
                  description: Any value other than asc is stored as desc.
                is_default:
                  type: boolean
                  default: false
                  description: >-
                    Only the literal true counts. Setting it clears the default
                    flag on every other view of the same webhook in the same
                    batch.
      responses:
        '201':
          description: >-
            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.
          content:
            application/json:
              schema:
                type: object
                required:
                  - view
                properties:
                  view:
                    type: object
                    required:
                      - id
                      - webhook_id
                      - name
                      - columns
                      - sortKey
                      - sortDir
                      - isDefault
                    properties:
                      id:
                        type: string
                      webhook_id:
                        type: string
                      name:
                        type: string
                      columns:
                        type: array
                        items:
                          type: object
                          required:
                            - key
                            - label
                          properties:
                            key:
                              type: string
                            label:
                              type: string
                      sortKey:
                        type:
                          - string
                          - 'null'
                      sortDir:
                        type: string
                        enum:
                          - asc
                          - desc
                      isDefault:
                        type: boolean
        '400':
          description: >-
            webhook_id is required, or a view-spec failure - name missing/over
            80 chars, columns empty or over 40, a bad or duplicate column key,
            or an invalid sort_key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            Not signed in, or the agent bearer token is invalid, unknown or
            revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Insufficient role (write capability required: owner, admin or
            developer), or a cookie-authenticated mutation missing the
            X-Requested-With: fetch header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Webhook not found in this project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - session: []
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable reason.
        retry_after:
          type: integer
          description: Seconds to wait. Present on 429.
        upgrade_url:
          type: string
          format: uri
          description: Present only on a monthly-quota 429.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: hookie_session
      description: >-
        The console's sealed session cookie, set by WorkOS AuthKit. Mutating
        requests also require the `X-Requested-With` CSRF header.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An OAuth 2.1 access token from a connected agent, audienced at the
        `/mcp` resource URI. The agent acts as its user, with that user's role
        narrowed to the granted `hookie:*` scopes. No CSRF header is required —
        a bearer token is not ambient credentials.

````