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

# Create a webhook source

> Creates an inbound webhook source for a supported provider preset. Requires an API key bound to a live workspace admin or owner with webhooks:write. The ingress URL and signing secret response can be replayed with the same Idempotency-Key for 24 hours; after that the secret is not retrievable. Configure the URL and secret in the external service, then attach a route to deliver its events into a conversation.



## OpenAPI

````yaml /openapi.json post /webhook-sources
openapi: 3.0.3
info:
  description: >-
    Generated from Ando's accepted public API v1 contract metadata. Current
    routes preserve legacy /api/v1 response envelopes while converging on the
    public https://api.ando.so/v1 shape.
  title: Ando Public API
  version: v1
servers:
  - description: Canonical public API host.
    url: https://api.ando.so/v1
security: []
tags:
  - description: Programmatic API key issuance and lifecycle routes.
    name: API Keys
  - description: Workspace agent lifecycle routes.
    name: Agents
  - description: Call detail and transcript routes.
    name: Calls
  - description: Membership-scoped conversation routes.
    name: Conversations
  - description: File upload lifecycle routes for public API message attachments.
    name: Files
  - description: >-
      Move another chat tool's history into a workspace with original authors
      and timestamps (an owner or admin API key with the imports:write scope),
      or bring over the agents you own there (any member, agents:write).
    name: Imports
  - description: >-
      Workspace member detail routes. Existing v1 paths keep member
      compatibility spellings.
    name: Members
  - description: Message and conversation message routes.
    name: Messages
  - description: Public realtime connection and protocol routes.
    name: Realtime
  - description: Search routes.
    name: Search
  - description: Outbound webhook endpoint and delivery routes.
    name: Webhooks
paths:
  /webhook-sources:
    post:
      tags:
        - Webhook sources
      summary: Create a webhook source
      description: >-
        Creates an inbound webhook source for a supported provider preset.
        Requires an API key bound to a live workspace admin or owner with
        webhooks:write. The ingress URL and signing secret response can be
        replayed with the same Idempotency-Key for 24 hours; after that the
        secret is not retrievable. Configure the URL and secret in the external
        service, then attach a route to deliver its events into a conversation.
      operationId: createWebhookSource
      parameters:
        - description: >-
            Required key for safe retries. Reusing it with different parameters
            returns 409 idempotency_conflict. The original result can be
            replayed for 24 hours while the created source or route remains
            unchanged.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            description: Idempotency key.
            type: string
            maxLength: 255
      requestBody:
        content:
          application/json:
            examples:
              sentry:
                summary: Create a Sentry source.
                value:
                  provider: sentry
            schema:
              $ref: '#/components/schemas/CreateWebhookSourceBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                source:
                  summary: Created source with its one-time signing secret.
                  value:
                    data:
                      display_name: Sentry
                      ingress_url: >-
                        https://api.ando.so/webhooks/inbound/44444444-4444-4444-8444-444444444444
                      provider: sentry
                      signing_secret: whsec_example_secret_shown_once
                      source_id: 55555555-5555-4555-8555-555555555555
                      status: active
              schema:
                $ref: '#/components/schemas/CreateWebhookSourceResponse'
          description: Created inbound webhook source.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AndoApiKey: []
        - BearerApiKey: []
components:
  schemas:
    CreateWebhookSourceBody:
      additionalProperties: false
      description: >-
        Inbound webhook source creation request. `provider` names a supported
        preset (sentry, linear, github, forgejo, gitlab, granola, notion,
        clickup, stripe, calendly, eas, app_store_connect, convex, posthog,
        pagerduty, grafana, attio); the preset supplies signature verification
        and event normalization.
      properties:
        display_name:
          description: >-
            Optional label for the author identity events post as. The source
            itself keeps the provider's canonical name.
          type: string
          nullable: true
        provider:
          description: Inbound provider preset key.
          type: string
        signing_secret:
          description: Signing secret the provider will use. Generated when omitted.
          type: string
          nullable: true
      required:
        - provider
      type: object
    CreateWebhookSourceResponse:
      additionalProperties: false
      description: >-
        Created inbound webhook source. The signing secret is returned exactly
        once.
      properties:
        data:
          additionalProperties: false
          description: Created source with its signing secret.
          properties:
            display_name:
              description: Source display name.
              type: string
            ingress_url:
              description: URL to configure in the external service's webhook settings.
              type: string
            provider:
              description: Provider preset key.
              type: string
            signing_secret:
              description: Signing secret — shown only in this response.
              type: string
            source_id:
              description: Webhook source identifier.
              type: string
              example: 01jzn7e61x3a7v9h2r7t2m3q4p
            status:
              description: Source status.
              type: string
          required:
            - display_name
            - ingress_url
            - provider
            - signing_secret
            - source_id
            - status
          type: object
      required:
        - data
      type: object
    LegacyErrorResponse:
      additionalProperties: false
      description: Current compatibility error envelope used by legacy /api/v1 routes.
      properties:
        error:
          description: Error message.
          type: string
        error_code:
          description: Optional machine-readable error code.
          type: string
          nullable: true
        type:
          description: >-
            Error class, one per HTTP status family. rate_limit_error,
            api_error, overloaded_error and timeout_error are worth retrying;
            the others need a different request. Retry a write only with the
            same Idempotency-Key: an api_error can mean it committed.
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - conflict_error
            - request_too_large
            - rate_limit_error
            - api_error
            - overloaded_error
            - timeout_error
          type: string
        request_id:
          description: >-
            The request id, also sent as the x-request-id header. Quote it when
            reporting a problem.
          type: string
        missing_scopes:
          description: Missing scopes.
          items:
            description: Scope.
            type: string
          type: array
      required:
        - error
      type: object
    PublicApiErrorResponse:
      additionalProperties: false
      description: Target public API error envelope.
      properties:
        error:
          additionalProperties: false
          description: Error details.
          properties:
            code:
              description: Machine-readable error code.
              type: string
            message:
              description: Human-readable error message.
              type: string
            request_id:
              description: Request identifier.
              type: string
              nullable: true
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Bad request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Missing or invalid API key.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Forbidden.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Not found.
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Conflict.
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiErrorResponse'
      description: Rate limit or quota exceeded.
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Internal server error.
  securitySchemes:
    AndoApiKey:
      description: Workspace API key. Current accepted keys use the ando_sk_ prefix.
      in: header
      name: x-api-key
      type: apiKey
    BearerApiKey:
      bearerFormat: ando_sk
      description: Compatibility transport for workspace API keys.
      scheme: bearer
      type: http

````

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