This article covers how to add and configure an API Goal in the Keap™ advanced automation builder, including how to set the Integration and Call Name values and how to connect the API Goal to a sequence. This article does not cover how to build a full automation campaign or how to set up specific third-party integrations. For help building a campaign, see how to create a campaign in the Keap automation builder.

Why API Goals Connect Your App Integrations to Your Automations

API Goals allow third-party apps and integrations to trigger automation sequences in your Keap account. An API (Application Programming Interface) is a secure connection that allows external software systems to send data to and receive data from Keap. When an event occurs in a connected third-party app — such as a purchase in an e-commerce platform — the app can send a signal to Keap through the API Goal, which then triggers the connected automation sequence. A sequence is the scheduled series of communications and processes that run automatically after the API Goal is triggered. This makes it possible to automate follow-up emails, tag contacts, and run other processes in Keap based on activity that happens in external apps.

How to Add and Configure an API Goal in the Keap Advanced Automation Builder

Follow these steps to add an API Goal to a campaign in the Keap advanced automation builder and connect it to a sequence. Before starting, confirm whether the Integration name and Call Name values need to be provided by the third-party app developer — some integrations require specific values that the developer will supply.

1. Drag an API Goal block from the goals panel onto the campaign canvas in the Keap advanced automation builder.

2. Double-click the API Goal block on the canvas to open the API Goal configuration settings.

3. Configure the API Goal settings. Enter a name in the Integration field and a name in the Call Name field. These values can be anything you choose, or they may be provided to you by the third-party app developer whose integration will be triggering the goal. The Integration and Call Name values are used by the third-party app to identify which API Goal to trigger in your Keap account.

4. Connect the API Goal to a sequence on the campaign canvas. Once the connection is made, test the API call from the third-party app to confirm the goal triggers the sequence correctly.

For technical documentation on the Keap REST API, including how to structure API calls and authenticate requests, see the Keap REST API developer documentation and resources.

Frequently Asked Questions

What does this article cover?

This article covers how to add and configure an API Goal in the Keap advanced automation builder, including how to set the Integration and Call Name values and how to connect the API Goal to a sequence. This article does not cover how to build a full automation campaign or how to set up specific third-party integrations. For help building a campaign, see how to create a campaign in the Keap automation builder.

Where do I get the Integration and Call Name values for my API Goal?

The Integration and Call Name values can be anything you choose if you are building a custom integration. If you are setting up an API Goal for a specific third-party app integration, the app developer or integration documentation will provide the exact Integration and Call Name values that must be used to match the configuration in that app.

How do I test my API Goal after setting it up?

After connecting the API Goal to a sequence on the campaign canvas, trigger the API call from the third-party app that will be sending the signal to Keap. Confirm that the sequence starts running in the Keap automation builder as expected. For technical guidance on constructing and sending API calls, see the Keap REST API developer documentation and resources.

Is there an example of using an API Goal with a specific integration?

Yes. For an example of how to create custom API Goals when using the BigCommerce integration with Keap, see the BigCommerce integration documentation or contact Keap Support for guidance on connecting BigCommerce to the Keap automation builder using API Goals.