Skip to main content
All CollectionsFAQs
Adding Your AppID, API Key and Webhook
Adding Your AppID, API Key and Webhook

How to configure your App Id, API Secret, and Webhook

Stacy Lane avatar
Written by Stacy Lane
Updated over 4 years ago

Please contact support@consensus.com to ensure that API is enabled on your eFax Corporate account, and to gather the following details:

  • AppID

  • API Key

  • UserID

  • Fax Number

Note: The AppID and API Key should be treated as sensitive information similar to a username and password. The API Key will not be displayed on subsequent visits to the page. Please ensure it is safely maintained for use when configuring additional locations.

Adding Your AppID and API Key

In the system, navigate to Settings ('gear' icon) > eFax Account:

Example of eFax Account option in Settings. 

Example of eFax Account option in Settings.

Enter the App ID in the App Id field, the API Key in the API Secret field, and then select Save Changes. Click Verify Credentials to confirm they are accurate.

Example of App Id and API Secret fields.

Example of App Id and API Secret fields.

Adding Webhook Information

The platform also uses a feature from eFax known as webhooks to get delivery of new faxes and to receive status updates on faxes sent by your organization. The urls below should be provided to an eFax support representative to assist in setting up your account.

Example of Webhook Information fields.

Example of Webhook Information fields.

Now that the AppID, API Key and Webhook have been configured, you may proceed to Adding Your eFax Number.

Did this answer your question?