Workflow ID returned with GET applications can not be used to trigger a build

[abbeyjackson]

I am using the API to trigger a build. Before triggering I do a GET call to get applications which contains a list of the workflowIds and workflowNames. The workflow id that is returned is named "Default workflow". But I don't have anything called that, right now I only have the sample workflow ("Codemagic Sample Workflow") that is added to the yaml configuration when you go through the wizard. When I trigger the build using the workflow that is returned (which, remember is for "Default Workflow") the build fails because the workflow doesn't exist.

I'm not sure where to go from here, has anyone seen this behaviour before?

[icarusdust]

Hi @abbeyjackson, I am not sure what it is like in your case without seeing it but workflowID is not inside name in yaml. For ex.:

 workflows:
   ios-release:
     name: iOS Workflow

In this sample, workflowID is ios-release, not iOS Workflow. I am running:

curl -H "Content-Type: application/json" \
     -H "x-auth-token: <API Token>" \
     --request GET https://api.codemagic.io/apps

and I can get that workflowID correctly among other workflows.

[abbeyjackson]

Sorry I should have included a sample of the response. This is what I am getting back:

            "workflowIds": [
                "638e6d073014fbbae1097d71"
            ],
            "workflows": {
                "638e6d073014fbbae1097d71": {
                    "_id": "638e6d073014fbbae1097d71",
                    "name": "Default Workflow",
                    "isPublic": false,
                    ....

I am not getting back the actual workflow I have in the project which is the codemagic sample workflow that is added when you go through the set up wizard

[icarusdust]

Please ignore my previous response because running cURL to get applications that are configured with codemagic.yaml rather than Flutter Workflow Editor won't be able to show you workflowID. The reason is that before triggering a build which means that your repo is cloned and that request has access to it in order to be able to fetch workflowID, no access is available to your workflow data. "name": "Default Workflow" is what is coming from a default Workflow Editor version of your app. In short, you cannot get workflow id of your app that is configured with codemagic.yaml by using that request before triggering a build.

[abbeyjackson]

I've already triggered builds through the codemagic app which were successful and I still see only Default Workflow:

            "workflowIds": [
                "638e6d073014fbbae1097d71"
            ],
            "workflows": {
                "638e6d073014fbbae1097d71": {
                    "_id": "638e6d073014fbbae1097d71",
                    "name": "Default Workflow",

[icarusdust]

@abbeyjackson sorry, the thread got out of my attention. Well, it won't matter that you have already created workflows, at the moment of triggering your build, there is no access available to your workflow data and that Default Workflow is created automatically and it is what you see in the list.

[abbeyjackson]

@abbeyjackson sorry, the thread got out of my attention. Well, it won't matter that you have already created workflows, at the moment of triggering your build, there is no access available to your workflow data and that Default Workflow is created automatically and it is what you see in the list.

Hi, maybe I am not understanding but I triggered the workflow already through through the Codemagic app as you can see in the screenshot in my last post. Since the workflow has already been triggered based on your previous reply my understanding is that "Default Workflow" should no longer be the name being returned.

In fact I created two sample workflows and triggered both of them successfully but as you can see in my previous post only a single "Default Workflow" is coming through from the API.

[abbeyjackson]

@icarusdust do you have any additional insight?

[dtrdic]

This discussion is being closed due to no activity in the last 14 days. You can reopen the discussion at any time if needed.

[boozook]

I have same problem.
I can't determine ID of any my workflows that defined in the codemagic.yaml.
As well as I can't trigger it via API because don't know an ID.
As mentioned multiple times above, we're know only ID of "Default Workflow", nothing more.
Any build within other workflow have id that is null.

Also I see field fileWorkflowIds in the API's response, but it always empty array.

Any suggestions please 🥺

[boozook]

@abbeyjackson
I have an answer! Finally!

To trigger your workflow, CM config yaml should be in master/main/default branch and you have to use yaml-field-key as ID of the workflow.
You can get it from API's response in the fileWorkflowId field! 🎉 (see my screenshot above in my prev. comment)

echo '{ "appId": "< APPID >", "workflowId": "< fileWorkflowId >", "branch": "< any branch >" }' | \
curl -H "Content-Type: application/json" \
     -H "x-auth-token: < API_TOKEN >" \
     -vX POST https://api.codemagic.io/builds \
     -d @-