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

# Create a webhook endpoint

> The response includes the signing `secret`. It's only returned once, so store it.



## OpenAPI

````yaml /openapi.yaml post /webhooks
openapi: 3.1.0
info:
  title: Capibo API
  version: '1.0'
  description: |
    Plan data-collection missions, track quality review, and pull accepted
    egocentric videos into your robot-training pipeline.
  contact:
    name: Capibo support
    email: support@capibo.work
servers:
  - url: https://api.capibo.work/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Missions
    description: Create and manage data-collection missions.
  - name: Planning
    description: Price a mission before you launch it.
  - name: Datasets
    description: Accepted videos, grouped per mission.
  - name: Videos
    description: Individual submissions and their quality-review results.
  - name: Exports
    description: Package a dataset into a training format and deliver it.
  - name: Billing
    description: Prepaid credits, transactions and promo codes.
  - name: Usage
    description: Collection volume and spend over time.
  - name: Webhooks
    description: Get notified when videos are accepted, missions finish and more.
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: >-
        The response includes the signing `secret`. It's only returned once, so
        store it.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
                - events
              properties:
                url:
                  type: string
                  format: uri
                  example: https://ml.example.com/hooks/capibo
                events:
                  type: array
                  items:
                    $ref: '#/components/schemas/EventType'
                  example:
                    - video.accepted
                    - export.ready
      responses:
        '201':
          description: The created endpoint, with its signing secret.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/WebhookEndpoint'
                  - type: object
                    properties:
                      secret:
                        type: string
                        example: whsec_9f2c4e7a1b...
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    EventType:
      type: string
      enum:
        - video.accepted
        - video.rejected
        - mission.completed
        - export.ready
        - balance.low
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          example: wh_3kd92m
        url:
          type: string
          format: uri
          example: https://ml.example.com/hooks/capibo
        events:
          type: array
          items:
            $ref: '#/components/schemas/EventType'
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication_error
                - permission_denied
                - not_found
                - conflict
                - payment_required
                - rate_limited
                - api_error
            code:
              type: string
              description: Machine-readable reason.
            message:
              type: string
              description: Human-readable explanation.
            param:
              type: string
              description: The parameter that caused the error
              if any.: null
  responses:
    BadRequest:
      description: The request is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: parameter_invalid
              message: tasks[0].videos must be at least 1.
              param: tasks[0].videos
    Unauthorized:
      description: The API key is missing, invalid or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: api_key_invalid
              message: Invalid API key.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from **Settings → API keys**, e.g. `cpb_live_…` or
        `cpb_test_…`.

````

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