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

# Get an event

> Returns one stored event by id, with its payload and whether notifications were sent.

Requires a realm member (or higher) on the realm that owns the event given by `id`.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-events.yaml post /v1/events/get_by_id
openapi: 3.0.3
info:
  title: 'CliqHub API: Events'
  version: 1.0.0
  description: >-
    The notification event bus. Events have a type from CliqHub's catalog
    (`run.failed`,

    `phase.input_required`, `hug.review_requested`, `daemon.offline`, …) or a
    custom type

    `custom.<name>` registered for a realm. Notification rules match events and
    deliver them to

    channels. Daemons and integrations submit events; CliqHub raises some
    itself. This is not

    the live run timeline (that is Runs).
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: Events
    description: >-
      The notification event bus. Events have a type from CliqHub's catalog
      (`run.failed`,

      `phase.input_required`, `hug.review_requested`, `daemon.offline`, …) or a
      custom type

      `custom.<name>` registered for a realm. Notification rules match events
      and deliver them to

      channels. Daemons and integrations submit events; CliqHub raises some
      itself. This is not

      the live run timeline (that is Runs).
paths:
  /v1/events/get_by_id:
    post:
      tags:
        - Events
      summary: Get an event
      description: >-
        Returns one stored event by id, with its payload and whether
        notifications were sent.


        Requires a realm member (or higher) on the realm that owns the event
        given by `id`.
      operationId: POST_v1_events_get_by_id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  minLength: 1
                  description: Persisted event id
              required:
                - id
            examples:
              default:
                value:
                  id: 2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  event:
                    $ref: '#/components/schemas/HubEvent'
                required:
                  - ok
              example:
                ok: true
                event:
                  id: 2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a
                  type: run.failed
                  occurred_at: '2026-10-07T10:25:00Z'
                  realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b
                  org_id: null
                  team: code-review
                  run_id: 0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f
                  phase: fix
                  daemon_id: 7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d
                  title: Run failed
                  message: npm test failed
                  severity: error
                  payload: {}
                  actor_id: null
                  created_at: '2026-10-07T10:25:01Z'
                  notifications: deferred
        '401':
          description: >-
            `unauthorized`: No `Authorization` header, or the token is
            malformed, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    ok: false
                    error:
                      code: unauthorized
                      message: Authentication required
        '403':
          description: >-
            `forbidden`: You can see the record but your role in its realm is
            too low or lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    ok: false
                    error:
                      code: forbidden
                      message: You do not have access to do this
        '404':
          description: >-
            `not_found`: The event does not exist or is in a realm you cannot
            see (404 rather than 403, so its existence is not revealed).


            `not_found`: No stored event has this id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error:
                      code: not_found
                      message: Not found
                not_found (endpoint):
                  summary: not_found (endpoint)
                  value:
                    ok: false
                    error: event '2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a' not found
                    code: not_found
        '422':
          description: >-
            `invalid_params`: The body fails the request schema: a field is
            missing or has the wrong type. `details.issues` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                invalid_params:
                  summary: invalid_params
                  value:
                    ok: false
                    error: Required
                    code: invalid_params
                    details:
                      issues:
                        - field: id
                          message: Required
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security:
        - BearerAuth: []
components:
  schemas:
    HubEvent:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          example: run.failed
        occurred_at:
          type: string
        realm_id:
          type: string
          nullable: true
        org_id:
          type: string
          nullable: true
        team:
          type: string
          nullable: true
        run_id:
          type: string
          nullable: true
        phase:
          type: string
          nullable: true
        daemon_id:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
        severity:
          type: string
          enum:
            - info
            - warn
            - error
            - critical
        payload:
          type: object
          additionalProperties: true
        actor_id:
          type: string
          nullable: true
        created_at:
          type: string
        notifications:
          type: string
          description: >-
            Whether notifications were sent now or later (for example
            `deferred`).
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cliq_tok_* | cliq_dt_*
      description: >-
        User PAT (`cliq_tok_…`, including session-scoped) or realm token
        (`cliq_dt_…`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.