REST API Notification Options when Target delivery Fails for Finished Projects
Use case
You might sometimes wonder why a specific XTM Cloud project is listed with the status "Finished", but there was an error in the target file, preventing it from getting delivered.
At first glance, you might consider such behavior illogical since if the target generation fails, the project status should not be that of “Finished”. This might be especially troublesome when you have a vast number of projects going through your pipelines, and for this reason there should be a way for you to get notified whenever projects end up in a failure state.
Solution – REST API method
Keep in mind that project completion and target generation are TWO SEPARATE processes, relating to workflow and file processing/generation respectively. Unfortunately, the described issue cannot be handled effectively on the XTM Cloud side, as the processes are too distinct.
Nonetheless, REST API offers a solution to it: you can add a file status check in the pipeline after the project is finished in XTM Cloud. For this purpose, use this method: Files Status API with fileType=TARGET and fileScope=JOB. This will provide information about all target files that attempted generation and whether they succeeded or not.