How is it possible to have an Automation Goal named "API" and drop API support in REST V2?

API Q&A
,
1

Help on this item in the Automation Builder: Learn more

2

The team decided not to move that endpoint forward because it was outdated and prone to issues. That said, I’ll bring this up again internally so I can share more details on any plans to support something similar in REST v2.

3

I’ll also raise this unexpected cost with my customers, one of whom has several income-producing campaigns (e.g. abandoned cart) that will become basically unuseable without re-programming the automations.

[EDITED TO ADD]
@OmarAlmonte
I’ve raised the issue with a longtime customer. It’ll spur their move to SalesForce.
Nevertheless, for the health of my WordPress plugin and its users, suppose you do decide to implement this and other missing features. Will you extend the sunset period?

It’s not my customer’s fault that the API Goal implementation sucks.
It’s not my customer’s fault your database schema sucks. Although DSQuery isn’t part of this rant, it’s incredibly important.
It’s not my customer’s fault that throwing more hardware at the problem doesn’t solve fundamental design and implementation issues.
It’s not my customer’s fault that software maintenance can be boring.

4

@Jeffrey_Chimene
I completely understand how impactful this is for you and for the customers who depend on these automations. The context you shared is extremely valuable, and I appreciate how clearly you’ve outlined the real-world effects this creates on your side.

We’re not extending the sunset date, and I want to highlight that we’re providing a 13-month transition period to give partners and customers meaningful time to adjust and prepare.

We’re actively monitoring every gap reported by the community, and those inputs are guiding the teams as we work through missing functionality. For this specific case, I’ll make sure it stays on the radar and I’ll share an update with you as soon as I’m able to.

5

@Jeffrey_Chimene - I can share with your frustrations, as I have been pointing out other gaps with the REST API lately. I also have an integration that uses the same XML-RPC endpoint as well.

But, there is a workaround solution in REST v2 via the “Add Contacts to an Automation Sequence” endpoint.
https://developer.keap.com/docs/restv2/#tag/Automation/operation/addContactsToAutomationSequenceUsingPOST

You would have to know the Automation and Sequence IDs to trigger this endpoint.

The “Retrieve a list of Sequences for a Campaign” endpoint will get the list of sequences. I noticed in v1 it was returned as part of the Campaign retrieval, but in v2 it has now been moved to a separate endpoint instead.

https://developer.keap.com/docs/restv2/#tag/Campaign/operation/getCampaignSequencesUsingGET

@OmarAlmonte - One of the benefits of the XML-RPC version is that the same API Goal can be used in different Campaigns. But, what are the issues that were identified, because nothing has been mentioned over the years that their were any issues with it?

The other thing to mention is that when these gaps are identified, how long will the solutions take to be implemented? It will not help if updates appear 6 months later, giving a shorter timeframe for developers to make those changes. It is the more complex integrations that will take time to transition across.

6

@Pav
I appreciate the feedback. I’d considered that approach. I might as well adopt database ID management and force users to that approach if the plugin is to remain viable. One of the virtues of the API Goal is that users don’t need to juggle IDs, whether thay’re tags, automations, or sequences via some bespoke ID to name management UI

7

Hi @Jeffrey_Chimene and @Pav,

The team took a second look at this gap and has decided to work on it, implementing an equivalent API Goal endpoint in REST v2. In the meantime, as a workaround, you can continue using the REST v1 endpoint here: Achieve API Goal.

I’ll make sure to keep you updated and let you know as soon as the v2 endpoint is ready so you can migrate your integrations.

Thanks for your patience and for sharing your feedback.

Howto validate app id
8

@Pav I can’t confirm a specific timeline at this point, but the team will aim to address the gaps as soon as possible.

9

Hi @Jeffrey_Chimene and @Pav,

I’m happy to share that this has just been released for v2! The documentation hasn’t been updated yet, but we’ll get that done soon.

Here’s an example of how you can call the endpoint using curl:

curl -X POST "https://api.infusionsoft.com/crm/rest/v2/automations/goals/achieve" \
  -H "Authorization: Bearer <redacted>" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": 123,
    "integration": "abc123",
    "call_name": "testcall"
  }'

CC: @Todd_Stoker @Timothy_Withers @andreibuga @David_Bullock Thought you might also be interested.

3 Likes
10

Thank you for your prompt attention to this matter.

2 Likes
11

Thanks for getting this fixed.

1 Like
12

Hi @OmarAlmonte
What are the expected responses?

13

@Jeffrey_Chimene here are the updated docs with the expected response body:

The documentation was just updated, so your browser might still be showing a cached version. If you don’t see the changes, please open it in an incognito window.

Here’s an example response:

{
    "results": [
        {
            "success": true,
            "message": "",
            "automation_id": 34,
            "goal_id": 2,
            "flow_start_results": [
                {
                    "success": true,
                    "message": "",
                    "flow_id": 3
                }
            ],
            "flow_stop_results": [
                {
                    "success": false,
                    "message": "No Sequences were configured to be stopped by this Goal.",
                    "flow_id": 0
                }
            ]
        }
    ]
}
14

Thanks, @OmarAlmonte It’s working as expected. I think Thryv will be updating the call to use a return type like the rest of the Rest API.

1 Like