> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/integrations/phone-and-sms/efax-setup-and-configuration.md).

# Fax Setup and Configuration

Welkin Health uses **Notifyre** as the fax vendor. Notifyre is a cloud-based fax platform that enables organizations to send and receive faxes directly from the Welkin Care Portal, without dedicated fax hardware. In Welkin, faxes are accessible from the Inbox in the Care Portal.

***

## Prerequisites

Before configuring Fax, make sure your organization's Fax feature is enabled. Contact your Welkin Implementation Manager or CSM to activate Fax for your environment.

***

## Admin Configuration

The Fax connection is configured in the **Admin portal → Integrations → Fax**. You will need three credentials from Notifyre: an API Token, a Signing Secret, and one or more System Fax Numbers.

### API Token

1. In Notifyre, go to the **Developer** section in the left-hand menu
2. Click the **API Tokens** tab → **+ New**
3. Enter a name and role; if necessary, specify an expiration date → **Save**
4. Copy the API token and paste it into the Admin Portal

> **Important:** The API token will only appear once. After you save it, it will be displayed as asterisks in the list and cannot be copied again.

### Signing Secret

1. In the same **Developer** section, go to the **Webhooks** tab → **+ New**
2. Enter the webhook URL in the following format:

   ```
   https://{apiUrl}/{tenantName}/{instanceName}/faxes/webhooks
   ```

   For example: `https://api.live.welkincloud.io/welkonnect/liza/faxes/webhooks`
3. Select the events: **Fax sent**, **Fax received**
4. Click **Save** — the webhook will appear in the table
5. In the **Signing Secret** column, click **Reveal**, then copy the value and paste it into the Admin Portal

### System Fax Numbers

1. In Notifyre, go to **Settings** in the left-hand menu → **Fax Numbers** tab
2. Click **+ Add New** to create a new number (you can also import an existing number)
3. Select the country and region → **Search** → select one of the available numbers
4. Add the number in the Admin Portal

You can add multiple fax numbers. When sending a fax from the Care Portal, users will be able to choose which number to use as the sender.

***

## Security Policies

New fax-related security policies are available in Designer. Assign them to the appropriate roles as needed:

* **Read** — Viewing faxes
* **Create** — Creating and sending faxes
* **Update** — Editing faxes and assigning faxes to patients
* **Delete** — Deleting faxes

***

## Fax Templates (Designer)

A **Fax Templates** section has been added to Designer. Templates are optional but allow care team members to select pre-built document templates when composing a fax, without having to upload a file each time.

The setup process is the same as for assessment templates. The file must be a **Word document (.docx format)**. Within the document, you can use variables related to the patient and the user, as well as those created in the Variable Builder.

***

## Sending a Fax (Care Portal)

The **Send Fax** button is available on both the Incoming and Sent Faxes tabs. Clicking it opens the fax sending form with the following fields:

* **Sender** — the fax number to send from. If multiple numbers have been configured, select the desired one from the drop-down list
* **Recipient** — the destination fax number
* **Subject** — the fax title

Welkin Health uses **Notifyre** as the fax vendor. Notifyre is a cloud-based fax platform that enables organizations to send and receive faxes directly from the Welkin Care Portal, without dedicated fax hardware. In Welkin, faxes are accessible from the Inbox in the Care Portal.

***

## Prerequisites

Before configuring Fax, make sure your organization's Fax feature is enabled. Contact your Welkin Implementation Manager or CSM to activate Fax for your environment.

***

## Admin Configuration

The Fax connection is configured in the **Admin portal → Integrations → Fax**. You will need three credentials from Notifyre: an API Token, a Signing Secret, and one or more System Fax Numbers.

### API Token

1. In Notifyre, go to the **Developer** section in the left-hand menu
2. Click the **API Tokens** tab → **+ New**
3. Enter a name and role; if necessary, specify an expiration date → **Save**
4. Copy the API token and paste it into the Admin Portal

> **Important:** The API token will only appear once. After you save it, it will be displayed as asterisks in the list and cannot be copied again.

### Signing Secret

1. In the same **Developer** section, go to the **Webhooks** tab → **+ New**
2. Enter the webhook URL in the following format:

   ```
   https://{apiUrl}/{tenantName}/{instanceName}/faxes/webhooks
   ```

   For example: `https://api.live.welkincloud.io/welkonnect/liza/faxes/webhooks`
3. Select the events: **Fax sent**, **Fax received**
4. Click **Save** — the webhook will appear in the table
5. In the **Signing Secret** column, click **Reveal**, then copy the value and paste it into the Admin Portal

### System Fax Numbers

1. In Notifyre, go to **Settings** in the left-hand menu → **Fax Numbers** tab
2. Click **+ Add New** to create a new number (you can also import an existing number)
3. Select the country and region → **Search** → select one of the available numbers
4. Add the number in the Admin Portal

You can add multiple fax numbers. When sending a fax from the Care Portal, users will be able to choose which number to use as the sender.

***

## Security Policies

New fax-related security policies are available in Designer. Assign them to the appropriate roles as needed:

* **Read** — Viewing faxes
* **Create** — Creating and sending faxes
* **Update** — Editing faxes and assigning faxes to patients
* **Delete** — Deleting faxes

***

## Fax Templates (Designer)

A **Fax Templates** section has been added to Designer. Templates are optional but allow care team members to select pre-built document templates when composing a fax, without having to upload a file each time.

The setup process is the same as for assessment templates. The file must be a **Word document (.docx format)**. Within the document, you can use variables related to the patient and the user, as well as those created in the Variable Builder.

***

## Sending a Fax (Care Portal)

The **Send Fax** button is available on both the Incoming and Sent Faxes tabs. Clicking it opens the fax sending form with the following fields:

* **Sender** — the fax number to send from. If multiple numbers have been configured, select the desired one from the drop-down list
* **Recipient** — the destination fax number
* **Subject** — the fax title
* **Related patient** — the patient the fax is associated with
* **Attachments** — files to include. Supported formats: JPG, PNG, PDF, DOC, XLS. Maximum 10 files with a combined size of up to 100 MB

By default, you can attach templates created in Designer or upload a file from your computer. If a patient is linked to the fax, you can also select files from that patient's Document Center.

You can preview each file before sending.

**Form actions:**

* **Save** — saves the fax as a draft, accessible in Fax Sent → Draft tab
* **Cancel** — discards the fax
* **Send Fax** — sends the fax immediately

***

## Search and Attachments

Faxes can be searched by:

* Phone number (`fromNumber` or `toNumber`)
* Subject

Attachments support the following file formats: `jpg`, `jpeg`, `png`, `pdf`, `docx`. Maximum 10 files with a total size of up to 100 MB.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.welkinhealth.com/integrations/phone-and-sms/efax-setup-and-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
