Update Webhook Endpoint

Updates an existing webhook endpoint.

PUT /webhooks/{webhook}

Update Webhook Endpoint

cURL

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

200

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"
  }
}

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.

Path Parameters

webhook · string · required

The webhook public id

Body

application/json

url · string<uri>

Maximum string length: 2048

is_active · boolean

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

200

application/json

WebhookEndpointResource

data · WebhookEndpointResource · object · required

Show child attributes