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

# Create a webhook

> Register a new webhook endpoint. The webhook will automatically subscribe to the `execution_complete` event.

Authentication credentials depend on the `auth_type`:
- `no_auth` — no additional fields required
- `basic` — requires `username` and `password`
- `bearer` — requires `token`

Requires the `write` scope.



## OpenAPI

````yaml POST /v1/webhooks
openapi: 3.1.0
info:
  title: SimpleDocs API
  version: 1.0.0
  description: >-
    The SimpleDocs API lets you programmatically manage repository documents,
    workflows, requests, and webhooks.


    All endpoints are scoped to the company associated with your OAuth
    application.


    **Rate limiting:** 600 requests per minute per IP address.


    **Base URL:** `https://app.simpledocs.com/api`
servers:
  - url: https://app.simpledocs.com/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Obtain access tokens via OAuth2 client credentials
  - name: Repository Documents
    description: Upload and manage documents in your repository
  - name: Workflows
    description: List workflows and retrieve their schemas
  - name: Requests
    description: Create and track legal requests
  - name: Webhooks
    description: Register webhooks to receive event notifications
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook
      description: >-
        Register a new webhook endpoint. The webhook will automatically
        subscribe to the `execution_complete` event.


        Authentication credentials depend on the `auth_type`:

        - `no_auth` — no additional fields required

        - `basic` — requires `username` and `password`

        - `bearer` — requires `token`


        Requires the `write` scope.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - url
              properties:
                name:
                  type: string
                  description: A human-readable name for the webhook.
                  example: Salesforce Integration
                url:
                  type: string
                  format: uri
                  description: The HTTPS URL that will receive webhook payloads.
                  example: https://example.com/webhooks/simpledocs
                auth_type:
                  type: string
                  enum:
                    - no_auth
                    - basic
                    - bearer
                  default: no_auth
                  description: The authentication method for webhook delivery.
                username:
                  type: string
                  description: Username for `basic` authentication.
                password:
                  type: string
                  description: Password for `basic` authentication.
                token:
                  type: string
                  description: Bearer token for `bearer` authentication.
      responses:
        '201':
          description: Webhook created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Webhook'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      security:
        - bearerAuth:
            - write
components:
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          example: webhook
        attributes:
          type: object
          properties:
            name:
              type: string
              example: Salesforce Integration
            url:
              type: string
              format: uri
              example: https://example.com/webhooks/simpledocs
            auth_type:
              type: string
              enum:
                - no_auth
                - basic
                - bearer
              example: bearer
            events:
              type: array
              items:
                type: string
              description: List of event names this webhook is subscribed to.
              example:
                - execution_complete
    RFC9457Error:
      type: object
      description: >-
        Error responses follow [RFC
        9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.
      properties:
        type:
          type: string
          description: A machine-readable error type identifier.
          example: parameter_missing
        status:
          type: integer
          example: 400
        title:
          type: string
          example: Bad Request
        detail:
          type: string
          description: A human-readable explanation of the error.
          example: File or URL is required
        instance:
          type: string
          description: The request path that generated the error.
          example: /api/v1/repository_documents
        request_id:
          type: string
          description: A unique identifier for the request, useful for support.
  responses:
    Unauthorized:
      description: The access token is missing, invalid, expired, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RFC9457Error'
          examples:
            expired:
              summary: Token expired
              value:
                type: token_expired
                status: 401
                title: Token Expired
                detail: The access token has expired.
                instance: /api/v1/workflows
                request_id: abc-123
            revoked:
              summary: Token revoked
              value:
                type: token_revoked
                status: 401
                title: Token Revoked
                detail: The access token has been revoked.
                instance: /api/v1/workflows
                request_id: abc-123
            invalid:
              summary: Invalid token
              value:
                type: invalid_token
                status: 401
                title: Invalid Token
                detail: The access token is invalid.
                instance: /api/v1/workflows
                request_id: abc-123
    Forbidden:
      description: The access token does not have the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RFC9457Error'
          example:
            type: insufficient_scope
            status: 403
            title: Forbidden
            detail: The access token does not have the required scope.
            instance: /api/v1/repository_documents
            request_id: abc-123
    UnprocessableEntity:
      description: The request was well-formed but could not be processed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RFC9457Error'
          example:
            type: repository_document_creation_error
            status: 422
            title: Repository document creation failed
            detail: File type is not supported
            instance: /api/v1/repository_documents
            request_id: abc-123
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Obtain a Bearer token via the [Create access
        token](/api-reference/authentication/create-token) endpoint using the
        OAuth2 client credentials flow.

````