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

# Register a webhook

> signing_secret is returned exactly once — store it immediately.



## OpenAPI

````yaml https://api.goparlay.io/docs/json post /v1/webhooks
openapi: 3.0.3
info:
  title: Parlay API
  description: >-
    Partner-facing API for Parlay pitch scoring, rep intelligence, and coaching.
    See API.md for the full spec.
  version: 0.1.0
servers:
  - url: http://localhost:3000
    description: production
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Service health and platform status
  - name: Analyses
    description: Submit and retrieve pitch scoring analyses
  - name: Orgs
    description: Partner org management
  - name: Reps
    description: Rep management
  - name: Keys
    description: API key lifecycle
  - name: Webhooks
    description: Webhook registration and delivery
  - name: Personas
    description: Rep persona intelligence
  - name: Methodologies
    description: Rep methodology intelligence
  - name: Synthesis
    description: Profile synthesis
  - name: Insights
    description: Org-level insights
  - name: Playbooks
    description: Playbook management + AI drafting
  - name: Prompts
    description: Custom AI prompts
  - name: Scoring
    description: Scoring profile config
  - name: Chat
    description: Scout AI chat
  - name: Dispositions
    description: Call dispositions
  - name: Practice
    description: Practice sessions
  - name: Bulk
    description: Batch and export
  - name: Usage
    description: Usage and billing
  - name: Audit
    description: Audit log
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Register a webhook
      description: signing_secret is returned exactly once — store it immediately.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                enabled_events:
                  type: array
                  items:
                    type: string
                    enum:
                      - analysis.queued
                      - analysis.completed
                      - analysis.failed
                      - persona.assigned
                      - methodology.assigned
                      - profile.synthesized
                      - playbook.draft.completed
                      - playbook.published
                      - insights.generated
                      - batch.completed
                      - batch.item.completed
                      - batch.item.failed
                      - export.ready
                      - all_day_session.processing_started
                      - all_day_session.detected
                      - all_day_session.completed
                      - all_day_session.failed
                      - webhook.test
                  minItems: 1
                name:
                  type: string
                  maxLength: 120
                  nullable: true
                description:
                  type: string
                  maxLength: 2000
                  nullable: true
              required:
                - url
                - enabled_events
              additionalProperties: false
      responses:
        '200':
          description: Default Response
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key (pk_sandbox_* or pk_live_*)

````