The API Access feature allows administrators to integrate and manage access between your backend systems and the Xfax platform. Administrators have the ability to create and manage API keys, as well as configure webhook destinations for automated event notifications.
Create API Key
The Create API Key function allows you to generate new API keys to securely manage access to the Xfax API from your backend systems.
Required fields:
Key Label – A descriptive name for the API key.
Expiry Date – Defines how long the API key remains valid.
Administrators can also control the level of access by enabling or disabling specific permissions, including:
Get Fax
Send Fax
Delete Fax
For additional security, API keys can be disabled at any time using the “Disable API Key” option.
Manage API Keys
The Manage API Keys function displays and manages all active API keys within the tenant. Each key entry includes details such as:
Key Label
Last Active
Expiration Date
Allowed Access
Status
Administrators can edit existing keys to update their name, expiry date, or permissions, as well as disable or delete keys when no longer needed.
Manage Webhooks
The Manage Webhooks function enables webhook integrations between Xfax and your backend platforms. Webhooks allow Xfax to automatically send real-time event notifications to a specified URL when certain actions occur.
Available webhook events include:
Fax Received Event
Fax Delivered Event
To activate, simply enable the desired webhook event and provide your destination URL.
