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

# Subscribe a webhook URL

> Returns `signing_secret` once — store it securely.



## OpenAPI

````yaml /openapi/integrations.json post /integrations/webhooks/subscribe
openapi: 3.1.0
info:
  title: Vendschat Integration API
  version: '1.0'
  description: >
    Workspace API for Zapier, Make, n8n, and custom HTTP clients.

    Authenticate with a Growth+ integration API key. Keys only authorize
    `/v1/integrations/*`.
  contact:
    name: Vendschat
    url: https://vendschat.com
servers:
  - url: https://api.vendschat.com/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Auth
    description: Verify API keys and workspace entitlements
  - name: Messages
    description: Channels, templates, and outbound sends
  - name: Contacts
    description: Lookup and manage contacts
  - name: Labels
    description: Workspace labels
  - name: Webhooks
    description: REST Hook subscribe lifecycle for Zapier, Make, and n8n
  - name: Platform helpers
    description: >-
      Dynamic form helpers for Zapier/Make connectors — prefer Messages send for
      custom HTTP
paths:
  /integrations/webhooks/subscribe:
    post:
      tags:
        - Webhooks
      summary: Subscribe a webhook URL
      description: Returns `signing_secret` once — store it securely.
      operationId: subscribeIntegrationWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSubscribeRequest'
            example:
              url: https://hooks.zapier.com/hooks/catch/000/xxx/
              events:
                - incoming.vendschat.messages
              source: zapier
              name: 'Zapier: inbound messages'
              payload_style: thin
      responses:
        '201':
          description: Subscription created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    WebhookSubscribeRequest:
      type: object
      required:
        - url
        - events
        - source
      properties:
        url:
          type: string
          format: uri
        events:
          type: array
          items:
            type: string
          example:
            - incoming.vendschat.messages
        source:
          type: string
          enum:
            - zapier
            - make
            - n8n
        name:
          type: string
        api_version:
          type: string
        payload_style:
          type: string
          enum:
            - thin
            - snapshot
    WebhookSubscription:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        url:
          type: string
        source:
          type: string
        events:
          type: array
          items:
            type: string
        api_version:
          type: string
          nullable: true
        payload_style:
          type: string
        is_active:
          type: boolean
        signing_secret:
          type: string
          description: Shown on create — store securely
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: '`Authorization: Bearer YOUR_API_KEY`'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative to Bearer auth

````

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