Fax for Agents

Fax for Agents Webhooks API

The webhooks API from Fax for Agents — 10 operation(s) for webhooks.

GitHub OpenAPI

Operations 12

GET /v1/webhooks List webhooks #
POST /v1/webhooks Register a destination (secret shown once) #
PATCH /v1/webhooks/{webhook_id} Change url, filters or pause #
DELETE /v1/webhooks/{webhook_id} Remove a destination #
POST /v1/webhooks/{webhook_id}/rotate-secret New secret; the old one signs too for 24 hours #
POST /v1/webhooks/{webhook_id}/test Send a signed webhook.test event to this destination #
GET /v1/webhook-deliveries Delivery attempts (no payload secrets) #
POST /v1/webhook-deliveries/{delivery_id}/replay Replay the event with the same event id #
POST /webhooks/stripe Stripe event delivery (signed by Stripe, no API key) #
POST /webhooks/telnyx Telnyx fax events (signed, no API key) #
POST /webhooks/telnyx/failover Telnyx fax events, failover URL #
GET /webhooks/telnyx/media/{fax_job_id} The transmitted PDF behind a signed 15-minute link (fetched by Telnyx, no API… #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-webhooks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-extraction-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-fax-job-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-quote-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-inbox-item-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-analytics-organization-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-number-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/faxforagents:faxforagents-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

faxforagents-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Webhooks API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged webhooks across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List webhooks
      operationId: list_webhooks
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookList'
    post:
      tags:
      - Webhooks
      summary: Register a destination (secret shown once)
      operationId: create_webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookWithSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/webhooks/{webhook_id}:
    patch:
      tags:
      - Webhooks
      summary: Change url, filters or pause
      operationId: update_webhook
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Webhooks
      summary: Remove a destination
      operationId: delete_webhook
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deleted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/webhooks/{webhook_id}/rotate-secret:
    post:
      tags:
      - Webhooks
      summary: New secret; the old one signs too for 24 hours
      operationId: rotate_webhook_secret
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookWithSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/webhooks/{webhook_id}/test:
    post:
      tags:
      - Webhooks
      summary: Send a signed webhook.test event to this destination
      operationId: test_webhook
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/webhook-deliveries:
    get:
      tags:
      - Webhooks
      summary: Delivery attempts (no payload secrets)
      operationId: list_webhook_deliveries
      parameters:
      - name: webhook_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Webhook Id
      - name: event_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Event Id
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/webhook-deliveries/{delivery_id}/replay:
    post:
      tags:
      - Webhooks
      summary: Replay the event with the same event id
      operationId: replay_webhook_delivery
      parameters:
      - name: delivery_id
        in: path
        required: true
        schema:
          type: string
          title: Delivery Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Delivery'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webhooks/stripe:
    post:
      tags:
      - Webhooks
      summary: Stripe event delivery (signed by Stripe, no API key)
      operationId: stripe_webhook
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookAck'
  /webhooks/telnyx:
    post:
      tags:
      - Webhooks
      summary: Telnyx fax events (signed, no API key)
      operationId: telnyx_webhook
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelnyxAck'
  /webhooks/telnyx/failover:
    post:
      tags:
      - Webhooks
      summary: Telnyx fax events, failover URL
      operationId: telnyx_webhook_failover
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelnyxAck'
  /webhooks/telnyx/media/{fax_job_id}:
    get:
      tags:
      - Webhooks
      summary: The transmitted PDF behind a signed 15-minute link (fetched by Telnyx, no API…
      operationId: telnyx_media
      parameters:
      - name: fax_job_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Job Id
      - name: exp
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Exp
      - name: sig
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sig
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookAck:
      properties:
        received:
          type: boolean
          title: Received
          default: true
        outcome:
          type: string
          title: Outcome
      additionalProperties: true
      type: object
      required:
      - outcome
      title: WebhookAck
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DeliveryPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Delivery'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: DeliveryPage
    WebhookWithSecret:
      properties:
        id:
          type: string
          title: Id
        url:
          type: string
          title: Url
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        event_types:
          items:
            type: string
          type: array
          title: Event Types
        status:
          type: string
          title: Status
        previous_secret_expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Secret Expires At
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        secret:
          type: string
          title: Secret
          description: whsec_... Shown once. Verify webhook-signature with it.
      additionalProperties: true
      type: object
      required:
      - id
      - url
      - description
      - event_types
      - status
      - previous_secret_expires_at
      - created_at
      - updated_at
      - secret
      title: WebhookWithSecret
    Deleted:
      properties:
        id:
          type: string
          title: Id
        deleted:
          type: boolean
          title: Deleted
          default: true
      additionalProperties: true
      type: object
      required:
      - id
      title: Deleted
    WebhookCreate:
      properties:
        url:
          type: string
          maxLength: 2000
          title: Url
        description:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Description
        event_types:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Event Types
          description: 'Empty or omitted: every event type.'
      additionalProperties: false
      type: object
      required:
      - url
      title: WebhookCreate
    WebhookList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Webhook'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: WebhookList
    Delivery:
      properties:
        id:
          type: string
          title: Id
        webhook_id:
          type: string
          title: Webhook Id
        event_id:
          type: string
          title: Event Id
        event_type:
          type: string
          title: Event Type
        attempt:
          type: integer
          title: Attempt
        status:
          type: string
          title: Status
        response_status:
          anyOf:
          - type: integer
          - type: 'null'
          title: Response Status
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
        replay_of:
          anyOf:
          - type: string
          - type: 'null'
          title: Replay Of
        schedule_s:
          items:
            type: integer
          type: array
          title: Schedule S
        next_attempt_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Attempt At
        created_at:
          type: string
          title: Created At
        delivered_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Delivered At
      additionalProperties: true
      type: object
      required:
      - id
      - webhook_id
      - event_id
      - event_type
      - attempt
      - status
      - response_status
      - error
      - duration_ms
      - replay_of
      - schedule_s
      - next_attempt_at
      - created_at
      - delivered_at
      title: Delivery
    WebhookUpdate:
      properties:
        url:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Url
        description:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Description
        event_types:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Event Types
        status:
          anyOf:
          - type: string
            enum:
            - active
            - paused
          - type: 'null'
          title: Status
      additionalProperties: false
      type: object
      title: WebhookUpdate
    TelnyxAck:
      properties:
        received:
          type: boolean
          title: Received
        outcome:
          type: string
          title: Outcome
        event_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Event Id
      additionalProperties: true
      type: object
      required:
      - received
      - outcome
      title: TelnyxAck
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Webhook:
      properties:
        id:
          type: string
          title: Id
        url:
          type: string
          title: Url
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        event_types:
          items:
            type: string
          type: array
          title: Event Types
        status:
          type: string
          title: Status
        previous_secret_expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Secret Expires At
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      additionalProperties: true
      type: object
      required:
      - id
      - url
      - description
      - event_types
      - status
      - previous_secret_expires_at
      - created_at
      - updated_at
      title: Webhook
    Event:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
        created_at:
          type: string
          title: Created At
        org_id:
          type: string
          title: Org Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          type: string
          title: Resource Id
        fax_job_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Fax Job Id
        schema_version:
          type: integer
          title: Schema Version
        correlation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Correlation Id
        data:
          additionalProperties: true
          type: object
          title: Data
      additionalProperties: true
      type: object
      required:
      - id
      - type
      - created_at
      - org_id
      - environment
      - project_id
      - resource_type
      - resource_id
      - fax_job_id
      - schema_version
      - correlation_id
      - data
      title: Event
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json