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

# Create webhook endpoint

> Registers a new webhook endpoint and performs a live reachability ping. If the endpoint is unreachable or returns an unexpected response, the request fails with 400 (webhook_verification_failed). The generated secret is returned once - store it securely.



## OpenAPI

````yaml /api-reference/openapi.json post /webhooks
openapi: 3.0.0
info:
  description: >-
    Unified social media inbox API. Read and respond to comments, DMs, reviews,
    and mentions across Instagram, Facebook, Threads, Google Business Profile,
    TikTok, LinkedIn, and YouTube through a single REST API. X/Twitter and
    Trustpilot coming soon.
  title: SocialAPI.AI
  contact:
    name: SocialAPI.AI Support
    email: support@social-api.ai
  license:
    name: MIT
  version: '1.0'
servers:
  - url: https://api.social-api.ai/v1
security: []
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create webhook endpoint
      description: >-
        Registers a new webhook endpoint and performs a live reachability ping.
        If the endpoint is unreachable or returns an unexpected response, the
        request fails with 400 (webhook_verification_failed). The generated
        secret is returned once - store it securely.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api_endpoints.CreateWebhookRequest'
        description: Endpoint config
        required: true
      responses:
        '201':
          description: Endpoint created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.CreateWebhookResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    api_endpoints.CreateWebhookRequest:
      type: object
      required:
        - events
      properties:
        events:
          description: Events is the list of event types to subscribe to.
          type: array
          items:
            type: string
            enum:
              - post.scheduled
              - post.published
              - post.failed
              - post.partial
              - post.updated
              - post.deleted
              - post.unpublished
              - post.retried
              - comment.received
              - dm.received
              - dm.sent
              - dm.referral
              - dm.postback
              - dm.status.sent
              - dm.status.delivered
              - dm.status.read
              - dm.status.failed
              - review.received
              - mention.received
              - account.connected
              - account.disconnected
              - page.removed
          example:
            - comment.received
            - dm.received
        url:
          description: URL is the HTTPS endpoint that will receive webhook POST requests.
          type: string
          example: https://example.com/webhooks/socialapi
    api_endpoints.CreateWebhookResponse:
      type: object
      properties:
        events:
          type: array
          items:
            type: string
          example:
            - comment.received
            - dm.received
        id:
          type: string
          example: wh_01HZ9X3Q4R5M6N7P8V2K0W1J
        message:
          type: string
          example: Store the secret securely. It will not be shown again.
        secret:
          type: string
          example: 4f3c2a1b9e8d7c6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2
        url:
          type: string
          example: https://example.com/webhooks/socialapi
    api_endpoints.ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/api_endpoints.ErrorBody'
    api_endpoints.ErrorBody:
      type: object
      properties:
        code:
          type: string
          example: resource.not_found
        message:
          type: string
          example: Account not found
        meta:
          type: object
          additionalProperties: {}
  securitySchemes:
    BearerAuth:
      description: >-
        Prefix your API key with "Bearer ". Example: `Authorization: Bearer
        sapi_key_...`
      type: apiKey
      name: Authorization
      in: header

````