This article covers how to create and configure an API Goal in the Keap™ automation builder, including how to set the Integration and Call Name, 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. 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. A sequence is the scheduled series of communications and processes that run automatically after the API Goal is triggered.
How to Create and Configure an API Goal in Keap
Follow these steps to add an API Goal to a campaign in the Keap 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.
-
Drag an API Goal from the goals panel onto the campaign canvas in the Keap automation builder.
The screenshot above shows the Keap automation builder campaign canvas with an API Goal being placed onto the canvas. The goals panel on the left side of the canvas displays available goal types including the API Goal. The API Goal appears as a block on the canvas after being dropped into position.
-
Open the API Goal settings by double-clicking the API Goal block on the canvas, or by single-clicking the block and selecting View and Edit.
The screenshot above shows the API Goal block on the Keap automation builder canvas after being selected. The View and Edit option appears when the block is single-clicked. Double-clicking the block opens the API Goal settings directly.
-
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.
The screenshot above shows the API Goal settings panel in the Keap automation builder. The panel displays the Integration field and the Call Name field. Both fields accept any text value. The values entered here must match the values configured in the third-party app that will be triggering the API Goal.
-
Connect the API Goal to an active 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.
The screenshot above shows the Keap automation builder campaign canvas with the API Goal connected to an active sequence. The connection is shown as a line drawn from the API Goal block to the sequence block. The sequence will run automatically each time the API Goal is triggered by the connected third-party app.
For technical documentation on the Keap REST API, including how to structure API calls and authenticate requests, see the Keap REST API developer documentation.
Frequently Asked Questions
What does this article cover?
This article covers how to create and configure an API Goal in the Keap 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.
What is a sequence in the Keap automation builder?
A sequence is a scheduled series of communications and automated processes that run in a specific order after a campaign goal is triggered. In the context of an API Goal, the sequence is the set of actions — such as sending emails, applying tags, or updating contact records — that Keap runs automatically each time the connected third-party app triggers the API Goal.
Comments
0 comments