Workflow API error handling

I have connected an external API to ION API and have been able to connect to it properly. However, I have a hard time getting the error handling to work.

The external API is structured to give a 200 response when the API is processed OK with a json body response with the following structure:

{
  <span class="hljs-attr">"result": {},
  <span class="hljs-attr">"resultMessage": "string",
  <span class="hljs-attr">"status": "100 CONTINUE"
}<br /><br /><span style="font-family:inherit;"><span style="font-family:arial, helvetica, sans-serif;">When the API fails (due to incorrect data in the input) the http response code is 500 with details about the error in the response body with the following structure:<br /><br />{<br /> "date": "dateTime",<br /> "status": "integer,<br /> "message": "string",<br /> "details": "string",<br /> "description": "string"<br />}<br /><br /><span style="font-family:arial, helvetica, sans-serif;">I would then want to retrieve these details to be able to route the workflow in different ways depending on this status, and send a notification to the user with the error message.<br />How can I configure the workflow to pick this information up? If I set the workflow to continue when an error occur, I still cannot set the response information as output parameters since it only seems to <br />pick up the output parameters if the response is 200. I can set the response status code to a variable but then I will only pick up 500 and I cannot send a notification to the user with the error message.<br /><br />

Find more posts tagged with

ION Workflow

Accepted answers

All comments

Legacy Contributor

If this is an integration use case, you can call your API from a Document flow -> Opt to raise a confirm BOD in case of a 500 error -> which can then be notified to a sys admin/ user.

If you want to capture the return code and do some logic, change some parameters, build a custom response etc, you can do so in an API flow (available in MT cloud).

Or you can use a combination of both - i.e., call an orchestrated API (of the API flow) that does your logic from the ION API connection point in the doc flow and further route it to different destinations in your doc flow.

Daniel Henningsver

Thank you for the response. This is what I would like to achieve, and I'm not sure which is the way to go or if it is possible.

An integration will trigger an api call, if the input is incorrect, the response code is 500 and in the body there is details of the error. In this case I want to trigger a notification to the support that the integration has failed. If the API is successful, some other check as made and in some cases a second api call is done using and output from the first API response.

I have tried using the API directly from a document flow and I then get a confirm BOD with the details if the API fails. However, I cannot retrieve any output from it to (based on some other rules) chain another API call in the document flow. For chaining I need both information that was input to the first API and then information from the result of that API call.

I have setup a workflow that is triggered by the document flow. In this case I get both api calls to work, so the chain works as expected. I can also detect a response code 500 to generate a notification to a user. But the only value I’m able to pickup is the response code 500. There is no way of getting the information why the api call failed. I have also tried to set the API connection to stop the workflow in case of errors, but I still cannot find the response body to get the details of the error.

Legacy Contributor

Hi DaHen,

From what i understand is you are receiving two different responses in the response body of your API call.

The first is a positive response and the second is a failure.

Have you tried using the output parameters section of the ION API tab in the workflow. You can set the response content to "BODY" and provide a JSON path of your response field that you would like to capture.

Make sure you select the optional checkbox. This will help the API to not fall in error in case if the field doesn't exist in your response.

You can map these fields to workflow parameters and can then use them ahead in the workflow.

Below is an example of such fields. Please let me know if this works for you.

Daniel Henningsver

Hi Hitesh,

Yes I have tried that but it doesn't work unfortunately. I think that since the response code is 500 the workflow just treat it as an error and will not pick anything from the response that you can use. The only options are the ones under Settings - How to handle errors where you can only retrieve the response code.

Daniel Henningsver

I managed to solve this by creating an endpoint policy which changed the response status 500 to 200. I was then able to retrieve also the error details from the response in the workflow.

Legacy Contributor

Hello @daniel-henningsver

I have the same scenario where I need to send email notification if there is an error in the ION API call. Can you please share this solution with me? or at least let me know how you configured this endpoint policy

Thanks

Daniel Henningsver

Hi Mo.A.Sh,

Under the custom API in ION API and under Endpoint Policies:

I created a new policy of type FaultHandling. Once you create this you get a template XML already provided, I adjusted it for my scenario, where I wanted status code 500 to be changed to 200:

Now when I run an api call that return status 500 from the external API, the gateway will change the status to 200, you can see this applied in the Monitor in ION API:

Even though the external api respond with an error code, the status code on the ION API response is 200.

Copyright © 2025 Infor. All rights reserved.