Create Webhook Endpoint

Creates a new webhook endpoint. Returns the endpoint and its signing secret. The signing secret is only shown once - store it securely.

POST /webhooks

Create Webhook Endpoint

cURL

curl --request POST \
  --url https://api.mintfax.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "events": []
}
'

201

Example

{ "data": { "id": "<string>", "url": "<string>", "events": [ "<string>" ], "is_active": true, "description": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }, "signing_secret": "<string>" }

Authorizations

Authorization · string · header · required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Body

application/json

url · string<uri> · required

Maximum string length: 2048

description · string | null

Maximum string length: 255

events · enum<string>[] | null

Maximum array length: 6

Available options: fax.queued, fax.sending, fax.delivered, fax.failed, balance.low, balance.topup

Response

201

application/json

WebhookEndpointResource

data · WebhookEndpointResource · object · required

Show child attributes

signing_secret · string · required