Skip to main content
PUT
/
account
/
webhooks
/
{id}
cURL
curl -X PUT https://api.mintfax.com/v1/account/webhooks/abc-123 \
  -H "Authorization: Bearer fx_test_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"is_active": false}'
{
  "data": {
    "id": "e1f2a3b4-c5d6-7890-abcd-ef0123456789",
    "url": "https://acme.com/webhooks/mintfax",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "events": [
      "fax.delivered",
      "fax.failed"
    ],
    "description": "Production notifications"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Sandbox keys (fx_test_...) route to the sandbox environment. Live keys (fx_live_...) route to production.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
url
string<uri>

URL to receive webhook events

Maximum string length: 2048
​
events
enum<string>[] | null

Event types to subscribe to. Null subscribes to all events.

Available options:
fax.queued,
fax.sending,
fax.delivered,
fax.failed,
fax.retry_scheduled,
balance.low,
balance.topup
​
is_active
boolean

Whether the endpoint receives events

​
description
string | null

Optional label for this endpoint

Maximum string length: 255

Response

Webhook endpoint updated

​
data
object
required