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

# Register a webhook endpoint



## OpenAPI

````yaml /openapi.yaml post /v1/webhooks
openapi: 3.1.0
info:
  title: Lymo Platform API
  version: 1.0.0
  description: >
    Public API for external integrations. Authenticated via Unkey API keys. All
    endpoints are org-scoped — the API key determines which organization's data
    is accessible.
servers:
  - url: https://platform.lymo.jp
    description: Production
  - url: http://127.0.0.1:54321/functions/v1/platform
    description: Local development (Supabase CLI)
security:
  - apiKeyAuth: []
tags:
  - name: system
    description: Health and status endpoints
  - name: videos
    description: Video data and analysis
  - name: deals
    description: Deal management and scoring
  - name: members
    description: Organization members
  - name: analyses
    description: Video analysis resources (async)
  - name: scorings
    description: Deal scoring resources (async)
  - name: webhooks
    description: Webhook endpoint management
  - name: keys
    description: API key self-service
  - name: search
    description: Cross-entity search
paths:
  /v1/webhooks:
    post:
      tags:
        - webhooks
      summary: Register a webhook endpoint
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                events:
                  type: array
                  items:
                    type: string
                    enum:
                      - video.analysis.completed
                      - video.analysis.failed
                      - deal.scoring.completed
                      - deal.scoring.failed
                      - video.ready
                  default: []
      responses:
        '201':
          description: Webhook registered. Secret is only returned on creation.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    allOf:
                      - type: object
                        required:
                          - id
                          - url
                          - events
                          - created_at
                        properties:
                          id:
                            type: string
                          url:
                            type: string
                            format: uri
                          events:
                            type: array
                            items:
                              type: string
                              enum:
                                - video.analysis.completed
                                - video.analysis.failed
                                - deal.scoring.completed
                                - deal.scoring.failed
                                - video.ready
                            description: >-
                              Event types this endpoint receives. Empty array
                              means all events.
                          created_at:
                            type: string
                            format: date-time
                      - type: object
                        required:
                          - secret
                        properties:
                          secret:
                            type: string
                            description: HMAC signing secret. Only returned on creation.
                  meta:
                    type: object
                    required:
                      - request_id
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for this request
                        example: req_abc123
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: Unkey API key (prefix lymo_)

````