How to customize JSON response for a successful journey execution

1. In the Event section, select the Callable Journey app from the Apps drop-down and choose New call as the trigger event,
2. Give a name to your journey in the Name field. For example, Custom JSON response.
3. Set application/json as the value for both the Request type and Response type fields.
   
   
   

2. Configuring the action

1. In the Steps section, click  Simple Action and select the Callable Journey app.
2. Choose Return raw response to API management from the Action drop-down.
3. Select Success as Response type.
4. Enter a custom JSON response to replace the default OK message. For example, "message": "The journey has executed successfully", "description": "You are receiving a custom JSON response instead of a pre-defined OK message that conveys no information" 
   
   
   
5. Save and start the journey.

3. Creating an API endpoint

1. Go to Tools -> API Management.
2. Select the API collection where you want to create an endpoint.
3. Click the + Create a new endpoint button.
4. Fill out the input fields:
   • Name: Name of the API endpoint (For example, Custom JSON response API).
   • Callable journey: Select the callable journey created earlier.
   • Method: Choose the HTTP method (For example, POST). Ensure you select the same method while testing the API else you will face an error.
   • Path: Specify the API path (For example, card_details). This will be appended to the API collection path.

5. Click Submit.

4. Creating a client profile

Create a client profile to generate an API key for the new API endpoint. Refer to this guide for detailed steps. The client profile should resemble this:

5. Testing the API endpoint

1. Open an API testing tool, such as Postman.
2. Copy the API key and enter it in the Headers tab.
3. Then copy the API endpoint, set the method to POST and execute it.

You will get the custom JSON response instead of OK.