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

# Start forwarding the project's logs and traces over OTLP/HTTP (JSON) to one tool

> A project has ONE integration. When one exists the request is refused with 409 unless `replace` is exactly `true`; a replace deletes the old integration (settings, credentials and counts) and is audited as replace_telemetry_integration. Endpoint URLs must be https, public hosts (no localhost, private, link-local or metadata addresses) and carry no credentials. Audited as create_telemetry_integration.



## OpenAPI

````yaml /openapi.json post /admin/api/projects/{pid}/telemetry
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.
  - name: Data API
    description: >-
      Read-only access to the datasets and columns a project exposes, with
      per-project keys.
  - name: Broadcast Logs
    description: >-
      Forward a project's logs and traces over OTLP/HTTP (JSON) to Datadog,
      Grafana Cloud, an OpenTelemetry Collector, PostHog or Sentry.
paths:
  /admin/api/projects/{pid}/telemetry:
    post:
      tags:
        - Broadcast Logs
      summary: >-
        Start forwarding the project's logs and traces over OTLP/HTTP (JSON) to
        one tool
      description: >-
        A project has ONE integration. When one exists the request is refused
        with 409 unless `replace` is exactly `true`; a replace deletes the old
        integration (settings, credentials and counts) and is audited as
        replace_telemetry_integration. Endpoint URLs must be https, public hosts
        (no localhost, private, link-local or metadata addresses) and carry no
        credentials. Audited as create_telemetry_integration.
      operationId: createBroadcastLogs
      parameters:
        - name: pid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    settings:
                      type: object
                      additionalProperties:
                        type: string
                      description: >-
                        Non-secret fields of the chosen vendor (see
                        `vendors[].fields`).
                    secrets:
                      type: object
                      additionalProperties:
                        type: string
                      description: >-
                        Secret fields. On PATCH and on a test of the same
                        vendor, a blank or missing secret keeps the stored
                        value.
                - type: object
                  required:
                    - vendor
                  properties:
                    vendor:
                      type: string
                      enum:
                        - datadog
                        - grafana_cloud
                        - otel_collector
                        - posthog
                        - sentry
                    enabled:
                      type: boolean
                      default: true
                    replace:
                      type: boolean
                      description: Must be true to replace an existing integration.
      responses:
        '201':
          description: Created (or replaced).
          content:
            application/json:
              schema:
                type: object
                properties:
                  integration:
                    type: object
                    properties:
                      id:
                        type: string
                      vendor:
                        type: string
                        enum:
                          - datadog
                          - grafana_cloud
                          - otel_collector
                          - posthog
                          - sentry
                      vendor_name:
                        type: string
                      signals:
                        type: array
                        items:
                          type: string
                          enum:
                            - logs
                            - traces
                      settings:
                        type: object
                        additionalProperties:
                          type: string
                        description: >-
                          The vendor's non-secret settings (site, region,
                          endpoint, instance id).
                      secrets_set:
                        type: array
                        items:
                          type: string
                        description: >-
                          The NAMES of the secret fields that are set. Secret
                          values are never returned.
                      secrets_unreadable:
                        type: boolean
                        description: >-
                          True when the stored credentials cannot be decrypted;
                          nothing is sent until they are saved again.
                      endpoints:
                        type: object
                        properties:
                          logs:
                            type: string
                          traces:
                            type: string
                        description: >-
                          Where each signal is POSTed (URLs only; credentials
                          travel in headers).
                      enabled:
                        type: boolean
                      created_by:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      status:
                        type: object
                        properties:
                          last_success_at:
                            type:
                              - string
                              - 'null'
                          last_error:
                            type:
                              - string
                              - 'null'
                          last_error_at:
                            type:
                              - string
                              - 'null'
                          exported_count:
                            type: integer
                            description: Log records and spans the tool accepted.
                          failed_count:
                            type: integer
                            description: >-
                              Export requests that failed (each is retried with
                              backoff).
                          dropped_count:
                            type: integer
                            description: >-
                              Log records and spans given up on after the last
                              retry, or refused (e.g. 401/403).
                          last_test_at:
                            type:
                              - string
                              - 'null'
                          last_test_ok:
                            type:
                              - boolean
                              - 'null'
        '400':
          description: >-
            A required field is missing or invalid, or an endpoint is not an
            allowed outbound URL.
        '403':
          description: Owner or admin only.
        '409':
          description: >-
            The project already has an integration and `replace: true` was not
            sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
                    enum:
                      - integration_exists
                  existing:
                    type: object
                    properties:
                      vendor:
                        type: string
                      vendor_name:
                        type: string

````