1. webhooks
AFAX-v4
  • AFAX API V4
    • Documents
    • oauth
      • /oauth/token
    • faxes
      • /faxes
      • /faxes/binary
      • /faxes/{rfid}/cancel
      • /faxes
      • /faxes/{rfid}
      • /faxes/{rfid}/media
      • /faxes/{rfid}
    • webhooks
      • /webhooks
        GET
      • /webhooks
        POST
      • /webhooks/signing-secret
        GET
      • /webhooks/signing-secret
        POST
      • /webhooks/signing-secret/rotate
        POST
      • /webhooks/{id}
        PUT
      • /webhooks/{id}
        DELETE
      • /webhooks/{id}/deliveries
        GET
      • /webhooks/{id}/rotate-secret
        POST
    • system
      • /system/health
    • Schemas
      • Webhook.WriteRequest
      • Webhook.Created
      • Webhook.AFAXWebhook
      • Webhook.SecretCreated
      • Webhook.SecretStatus
      • Webhook.Delivery
      • FaxSubmission.CreateFaxRequest
      • FaxSubmission.FaxSender
      • FaxSubmission.FaxRecipient
      • FaxSubmission.FaxDocumentSource
      • FaxSubmission.FaxCoverPage
      • FaxSubmission.CreateFaxResponse
      • FaxSubmission.FaxResourceLinks
      • FaxResult.FaxResult
      • FaxResult.FaxDocumentTotals
      • FaxResult.FaxOutcome
      • FaxResult.FaxResultPage
      • FaxResult.FaxLifecycleResponse
      • Auth.TokenResponse
  1. webhooks

/webhooks/{id}

PUT
/webhooks/{id}

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Successful response
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.faxlink.ca/afx/v4//webhooks/' \
--header 'Content-Type: application/json' \
--data '{
    "url": "string",
    "payloadMode": "string",
    "events": [
        "string"
    ],
    "enabled": true
}'
Response Response Example
{
    "id": "string",
    "url": "string",
    "payloadMode": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "events": [
        "string"
    ],
    "enabled": true,
    "secretVersion": 0
}
Modified at 2026-09-15 22:26:45
Previous
/webhooks/signing-secret/rotate
Next
/webhooks/{id}
Built with