Before Kartra can accept any inbound API call, you (the developer) must create a custom App and submit it for review.

To get started, navigate to Settings > Integrations in your account's lower left menu and select My Apps.

Test vs Live mode

My custom app dashboard

Click the add App button in the top right to get started.

On creation, your App will be activated in Test Mode. While in Test Mode, the App is 100% operational and can execute all commands from our API system.

There are two limitations while in Test Mode:

  • Kartra will not send out any email to any lead registered while on Test Mode.
  • Any lead registered while in test mode will have its domain name replaced by @kartra.com. For example, executing the Lead_Create API instruction for lead [email protected] will subscribe that user to your Kartra account under email [email protected] instead.

To activate the mailing system, submit your App for live activation. Our admins will manually review your application and respond within a few business days.

Please Note: You cannot turn on live mode just to test your content with live emails. When you switch to live mode your content/application will be reviewed by our review team and it must be complete. If your content is not done, you will be reset back to test mode.

App ID and API keys

Each App has a unique App ID, which must be included in every API call you send to Kartra. Kartra will not accept any API call that doesn’t include a valid App ID.

Remember that there are two roles in this process:

  1. The App developer: most likely you, the creator of the 3rd party software looking to create an integration with Kartra. Yours will be the App ID.
  2. The App user: most likely your customers, but it could also be yourself in case you’re using your own App. Either way, the App user must also have an active Kartra account, since the API will be expecting the user's API Key and API Password.

The actions commanded by the API call (ie: subscribe a lead to a list) will be executed in the App user’s Kartra account, not in the App developer’s Kartra account.

*Please Note: The App is just the conductor that executes an action on behalf of the App User.