Provider guides
Instantly
What’s supported
Supported actions
This connector supports:
- Read Actions, including full historic backfill and incremental read.
- Write Actions.
- Proxy Actions, using the base URL
https://api.instantly.ai/api
.
Supported Objects
The Instantly connector supports reading from the following objects:
- accounts
- campaigns
- emails
- lead-lists
- inbox-placement-tests
- background-jobs
- custom-tags
- block-lists-entries
- lead-labels
- workspace-group-members
- workspace-members
- leads/list
- campaigns/analytics
- campaigns/analytics/daily
- campaigns/analytics/steps
- inbox-placement-tests/email-service-provider-options
- audit logs
The Instantlty connector supports writing from the following objects:
- accounts
- campaigns
- emails/reply
- lead-lists
- inbox-placement-tests
- custom-tags
- block-lists-entries
- lead-labels
- workspace-group-members
- workspace-members
- email-verification
- leads/merge
- leads/update-interest-status
- leads/subsequence/remove
- leads/move
- leads/export
- leads/subsequence/move
- custom-tags/toggle-resource
- workspaces/current
Example integration
For an example manifest file of an Instantly integration, visit our samples repo on Github.
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 using the example.
- Deploy it using the amp CLI.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Calls, you can start making Proxy API calls.
Creating an API key for Instantly:
-
Log in to your Instantly Account.
-
Navigate to settings.
-
Click Integraions and navigate to APIKeys.
-
Click Create API Key.