Provider guides
Instantly
What’s supported
Supported actions
The Instantly connector supports:
- Read Actions, including full historic backfill. Please note that incremental read is not supported, a full read of the Instantly instance will be done for each scheduled read.
- Write Actions.
- Proxy Actions, using the base URL
https://api.instantly.ai/api
.
Supported Objects
The Instantly connector supports reading to the following objects:
- campaigns
- accounts
- emails
- tags While writing to the following objects:
- tags
- leads
- blocklist-entries
- unibox-replies
Example integration
To define an integration for Instantly, create a manifest file that looks like this:
Using the connector
This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)
To start integrating with Instantly:
- Create a manifest file like the example above.
- Deploy it using the amp CLI.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
- Start making Proxy Calls, and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector’s base URL is
https://api.instantly.ai/api
.
Creating an API key for Instantly
Click here for more information about generating an API key for Instantly. The UI components will display this link, so that your users can successfully create API keys.