API Keys

Overview

The "API Keys" page is where your API keys, credentials, and settings can be managed. All existing Master Accounts (prior to 6 June 2023) by default will have 4 channels active, i.e. FTP, HTTP, Email & Web Service. Each Key has unique credentials and are specific for that channel. Credentials can be changed at any stage, but it is important to note that by changing the API credentials, any current implementation that uses those API credentials will break.

Kindly note that newly created Master Accounts, including Sub-Accounts, will not have any active channels.

How to Create an API Key

Simply click on the "Profile" icon to the top-right of your screen, select the "API Keys" option, and follow these easy steps:

If this is a new master or sub account, you will need to first create an API Key by clicking '+ Create API Key' in the top right corner and select your required API from the list that matches your needs.

The list is comprised of the following options:

• FTP
• REST
• HTTP
• Web Service
• Email

From here you can choose to create your own credentials or have them auto generated for you.

Please make sure to save and store your API Secret (password) in a safe place before closing the modal as you will not be able to see your API Secret again without generating a new one.

Changing your Credentials

Simply click on "Settings" on the left-hand control panel menu and select the "API Keys" option. You will find a list of all your active API Channels and can proceed to click on the "Actions" icon to the right of a specific channel. You will then be able to make the necessary changes.

IP Whitelisting

To whitelist an IP address, or multiple IP addresses, simply click on "Settings" on the left-hand control panel menu and select the "API Keys" option. You will find a list of all your active API Channels and can proceed to click on the "Actions" icon to the right of a specific channel and select the "IP Whitelist" option.

Applying an Automation Flow to your API Key

Simply click on "Settings" on the left-hand control panel menu. Select the "API Keys" option, click on the "Actions" icon to the right of the specific API Key, and select "Settings."

Select an Automation Flow (Default Reply Rule)

Assign a default Automation Flow (Reply Rule) to your API Key by clicking on the dropdown under "Default Automation Flow (Reply Rule)", and then click on "Update Settings" to apply your new rule.

Edit an Existing Automation Flow (Default Reply Rule)

Edit your existing Automation by clicking on "Edit", and making the necessary changes to the Automation Flow within the Flow Builder.

Create a New Automation Flow (Default Reply Rule)

Create a new Automation Flow by clicking on the "+ Create" button and building your Automation within the Flow Builder.

📘

Important Information

• Remember to assign it to your specific API Key if you would like to use the Automation as your default.