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

# Create a webhook endpoint

> Register a URL to receive event notifications.



## OpenAPI

````yaml /api-reference/openapi.json post /webhooks
openapi: 3.1.0
info:
  title: Autoposting API
  description: >-
    Schedule, publish, and AI-enhance social content across X, LinkedIn,
    Instagram, Threads, and YouTube. All responses use the `{ "success":
    boolean, "data": ... }` envelope. Authenticate with an API key
    (`Authorization: Bearer sk-social-...` or `x-api-key: sk-social-...`).
  version: 1.0.0
servers:
  - url: https://app.autoposting.ai/api-proxy
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Agents
    description: >-
      Create and manage AI agents that autonomously generate and schedule
      content, trigger runs, inspect outputs, and track statistics.
  - name: API Keys
    description: >-
      Create, list, update, and revoke API keys for programmatic access to the
      Autoposting.ai API.
  - name: Auth
    description: >-
      Signup, login, logout, social login, profile management, email change, and
      session management.
  - name: Billing
    description: >-
      Manage subscriptions, credits, plan changes, billing history, and the
      customer portal.
  - name: Brands
    description: >-
      Create, list, update, delete, and reorder brands. Each brand maps to a set
      of social media accounts.
  - name: Carousels
    description: >-
      Create, manage, and AI-generate carousel posts for LinkedIn and other
      platforms.
  - name: Clips
    description: >-
      Upload, manage, render, and publish video clips, including multipart
      upload, AI candidate generation, and credit billing.
  - name: Knowledge Base
    description: >-
      Knowledge bases, document ingestion, semantic search, and AI content idea
      generation.
  - name: Notifications
    description: List, read, and manage in-app notifications and notification preferences.
  - name: Organizations
    description: >-
      Create, list, update, and delete organizations (workspaces), including a
      safeguarded deletion flow with a grace period.
  - name: Platform OAuth
    description: >-
      Connect social media accounts via OAuth and manage platform tokens for X,
      LinkedIn, Instagram, Threads, and YouTube.
  - name: Posts
    description: Create, manage, schedule, publish, and AI-enhance posts across platforms.
  - name: Teams
    description: >-
      Manage team members, invitations, invite links, permission groups,
      brand-level overrides, ownership transfers, and allowed email domains.
  - name: Usage
    description: >-
      Usage summaries, token breakdowns, feature access, onboarding progress,
      and account management endpoints.
  - name: Webhooks
    description: >-
      Configure outbound webhook endpoints to receive real-time event
      notifications from Autoposting.ai.
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: Register a URL to receive event notifications.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
                - events
              properties:
                url:
                  type: string
                  format: uri
                  description: HTTPS URL to deliver events to. Must be publicly accessible.
                events:
                  type: array
                  items:
                    $ref: '#/components/schemas/WebhookEventType'
                  description: >-
                    Event types to subscribe to. Use ["*"] to receive all
                    events.
                secret:
                  type: string
                  description: >-
                    Signing secret used to verify webhook payloads. If provided,
                    each delivery includes an X-Autoposting-Signature header
                    with an HMAC-SHA256 signature.
                enabled:
                  type: boolean
                  default: true
                  description: 'Whether the webhook is active. Default: true.'
              example:
                url: https://your-server.com/webhooks/autoposting
                events:
                  - post.published
                  - post.failed
                  - clip.render.completed
                secret: whsec_your_signing_secret
      responses:
        '200':
          description: Webhook created
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/Webhook'
                example:
                  success: true
                  data:
                    id: wh_01HXYZ
                    url: https://your-server.com/webhooks/autoposting
                    events:
                      - post.published
                      - post.failed
                      - clip.render.completed
                    enabled: true
                    createdAt: '2024-01-01T00:00:00Z'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - message
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  message:
                    type: string
                example:
                  success: false
                  error: unauthorized
                  message: Missing or invalid API key
components:
  schemas:
    WebhookEventType:
      type: string
      description: Webhook event type. Use "*" to subscribe to all events.
      enum:
        - post.published
        - post.failed
        - post.scheduled
        - clip.render.completed
        - clip.render.failed
        - agent.run.completed
        - agent.run.failed
        - '*'
    Webhook:
      type: object
      required:
        - id
        - url
        - events
        - enabled
      properties:
        id:
          type: string
          example: wh_01HXYZ
        url:
          type: string
          format: uri
          example: https://your-server.com/webhooks/autoposting
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        enabled:
          type: boolean
          example: true
        createdAt:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00Z'
        lastDeliveryAt:
          type: string
          format: date-time
          example: '2024-01-10T09:05:00Z'
        lastDeliveryStatus:
          type: string
          example: success
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key as `Authorization: Bearer sk-social-...`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API key as `x-api-key: sk-social-...`'

````