openapi: 3.1.0
info:
  title: VeraDial API
  version: '2026-09-23'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-23: 8 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; VeraDial has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 0
    documentation: 8
    pages-with-code: 0
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-23'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://veradial.com/help/zapier-integration-api
servers:
- url: https://api.veradial.com/api/v1/integrations/zapier
paths:
  /hooks:
    post:
      operationId: post_hooks
      tags:
      - Hooks
      summary: Creates or reactivates a REST Hook subscription for Zapier events.
      x-source: https://veradial.com/help/zapier-integration-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHooksRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHooksResponse'
      x-evidence:
        kind: documentation
  /hooks/{id}:
    delete:
      operationId: delete_hooks_id
      tags:
      - Hooks
      summary: Unsubscribes a REST Hook subscription.
      x-source: https://veradial.com/help/zapier-integration-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteHooksIdResponse'
      x-evidence:
        kind: documentation
  /keys:
    get:
      operationId: get_keys
      tags:
      - Keys
      summary: Returns the API keys status including enabled, entitled, and list of key records.
      x-source: https://veradial.com/help/zapier-integration-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeysResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_keys
      tags:
      - Keys
      summary: Creates a new API key with the given name.
      x-source: https://veradial.com/help/zapier-integration-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKeysRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostKeysResponse'
      x-evidence:
        kind: documentation
  /keys/{id}:
    delete:
      operationId: delete_keys_id
      tags:
      - Keys
      summary: Revokes the API key and deactivates all linked subscriptions.
      x-source: https://veradial.com/help/zapier-integration-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /lines:
    get:
      operationId: get_lines
      tags:
      - Lines
      summary: Returns the list of current active or suspended VeraDial-hosted lines for the authenticated account.
      x-source: https://veradial.com/help/zapier-integration-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLinesResponse'
      x-evidence:
        kind: documentation
  /me:
    get:
      operationId: get_me
      tags:
      - Me
      summary: Tests the API key and returns the connected VeraDial account details.
      x-source: https://veradial.com/help/zapier-integration-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMeResponse'
      x-evidence:
        kind: documentation
  /samples:
    get:
      operationId: get_samples
      tags:
      - Samples
      summary: Returns up to three recent events or a deterministic synthetic sample matching the kind-and-line filter.
      x-source: https://veradial.com/help/zapier-integration-api
      parameters:
      - name: kind
        in: query
        required: true
        schema:
          type: string
        description: 'Event type filter: call.screened, voicemail.received, sms.reply_sent, or appointment.booked'
      - name: lineId
        in: query
        required: false
        schema:
          type: string
        description: Optional line UUID; null or empty means all lines
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSamplesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostHooksRequest:
      type: object
      properties:
        targetUrl:
          type: string
          description: Public HTTPS endpoint URL for webhook delivery
        kind:
          type: string
          description: 'Event type: call.screened, voicemail.received, sms.reply_sent, or appointment.booked'
        lineId:
          type: string
          description: Optional VeraDial line UUID; null or empty means all lines
      required:
      - targetUrl
      - kind
    PostHooksResponse:
      type: object
      properties:
        id:
          type: string
    DeleteHooksIdResponse:
      type: object
      properties:
        id:
          type: string
    GetKeysResponse:
      type: object
      properties:
        enabled:
          type: boolean
        entitled:
          type: boolean
        keys:
          type: array
    PostKeysRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the API key, e.g., "Zapier"
      required:
      - name
    PostKeysResponse:
      type: object
      properties:
        apiKey:
          type: string
          description: The secret API key value shown only in this response
    GetLinesResponse:
      type: object
      properties:
        lines:
          type: array
          description: Array of line objects containing id, phoneNumber, label, isPrimary, and status
    GetMeResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    GetSamplesResponse:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        version:
          type: integer
        kind:
          type: string
        source:
          type: string
        occurredAt:
          type: string
        account:
          type: object
        line:
          type: object
        data:
          type: object
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Hooks
- name: Keys
- name: Lines
- name: Me
- name: Samples