> ## 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.

# List event types

> Lists CliqHub's event catalog, the types notification rules can match. Send `{}`.

Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`). Results are limited to what that user can see.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-events.yaml post /v1/events/types/list
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/types/list:
    post:
      tags:
        - Events
      summary: List event types
      description: >-
        Lists CliqHub's event catalog, the types notification rules can match.
        Send `{}`.


        Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`).
        Results are limited to what that user can see.
      operationId: POST_v1_events_types_list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
              description: Empty body — returns the fixed Hub catalog
            examples:
              default:
                value: {}
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  types:
                    type: array
                    items:
                      type: string
                required:
                  - ok
              example:
                ok: true
                types:
                  - run.started
                  - run.completed
                  - run.failed
                  - phase.input_required
                  - hug.review_requested
                  - daemon.offline
        '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`: A daemon token was used; this route needs a user token.'
          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
        '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:
    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.