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

# Create Webhook

> Register an account-wide webhook. When **any** interview in your account is completed, a `POST` request is sent to your `hook_url` containing the completed interview in the public API shape — `study_id`, the `participant`, `status`, `quality`, `messages`, recording links, and screener responses (the same shape returned by `GET /interviews/{interview_id}`).

Webhooks are not scoped to a single study — you do not pass a `study_id`. The response includes a `signing_secret` (shown **once**): every delivery is signed with it via an `X-UI-Signature` header (HMAC-SHA256 of `"<X-UI-Timestamp>.<body>"`), so your endpoint can verify the request is genuine. See [Webhooks](/api-reference/webhooks/overview) for the full payload schema, signature verification, and delivery behavior.



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/webhooks/
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/webhooks/:
    post:
      tags:
        - public-webhooks
      summary: Create Webhook
      description: >-
        Register an account-wide webhook. When **any** interview in your account
        is completed, a `POST` request is sent to your `hook_url` containing the
        completed interview in the public API shape — `study_id`, the
        `participant`, `status`, `quality`, `messages`, recording links, and
        screener responses (the same shape returned by `GET
        /interviews/{interview_id}`).


        Webhooks are not scoped to a single study — you do not pass a
        `study_id`. The response includes a `signing_secret` (shown **once**):
        every delivery is signed with it via an `X-UI-Signature` header
        (HMAC-SHA256 of `"<X-UI-Timestamp>.<body>"`), so your endpoint can
        verify the request is genuine. See
        [Webhooks](/api-reference/webhooks/overview) for the full payload
        schema, signature verification, and delivery behavior.
      operationId: createWebhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookCreate:
      properties:
        hook_url:
          type: string
          title: Hook Url
          description: >-
            Webhook URL to receive completed-interview data for every study in
            your account
      additionalProperties: false
      type: object
      required:
        - hook_url
      title: WebhookCreate
    Webhook:
      properties:
        id:
          type: string
          title: Id
        hook_url:
          type: string
          title: Hook Url
        signing_secret:
          anyOf:
            - type: string
            - type: 'null'
          title: Signing Secret
          description: >-
            HMAC secret for verifying delivery signatures. Returned once, at
            creation — store it securely; it is never shown again.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - hook_url
      title: Webhook
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````