Skip to main content

eFax Setup

Connecting eFax Corporate to Caddi with an App ID and API Key

eFax connects to Caddi with an App ID and API Key from your eFax Corporate Admin portal, plus the User ID of the eFax user that Caddi acts as.

Before you start

You'll need:

  • An eFax Corporate account that is API-enabled. If you don't see the API management settings in your account, contact your eFax Corporate account manager.

  • An eFax Corporate administrator with API Management turned on. The main Administrator can turn it on: in the eFax Corporate Admin portal, go to the Users tab, select the administrator, click Advanced Settings, then Access Rights, toggle API Management to ON, and click Update Admin.

  • Owner or Admin access to your Caddi organization

Step 1: Create an App ID and API Key in eFax

eFax issues one App ID per group. On the API Setting tab, eFax labels it API ID.

  1. In the eFax Corporate Admin portal, go to the Groups tab.

  2. Click the group you want to use, or click Create Group.

  3. Click Advanced Settings, then API Setting.

  4. Toggle Fax API Access to ON.

  5. Click Update Group. The confirmation message shows the new API ID and API Key. They are also shown on the Advanced Settings > API Setting tab.

  6. Copy the API ID and the API Key.

Do not send this key by email, chat, or a support ticket. Paste it straight into Caddi in Step 3, or keep it in a password manager until you do.

Step 2: Copy the User ID in eFax

Caddi acts as one eFax user. Pick a user in the group from Step 1. eFax gives each fax number assigned to the user its own User ID, so the user needs at least one assigned fax number. If the user has none, assign one first.

  1. In the eFax Corporate Admin portal, go to the Users tab.

  2. Find the user in that group and click Edit User, or click Add User to create one.

  3. Toggle API Access to ON and save the user. On the Edit User page, click Update User.

  4. Open Advanced Settings, then API Details. This page lists the user's fax numbers, one row per number, with their App ID and User ID.

  5. Copy the User ID on the row for the fax number Caddi should use.

Step 3: Add the credentials in Caddi

  1. In Caddi, open Settings, then Integrations.

  2. Under Connectors you can configure, find eFax and click Configure.

  3. Paste the API ID from Step 1 into App ID.

  4. Paste the API Key from Step 1 into API Key.

  5. Paste the User ID from Step 2 into User ID.

  6. Leave API Base URL blank.

  7. Click Save Configuration.

Sources

Related Articles
Did this answer your question?