How to test an API endpoint using Try-catch

1. In the Event section, select the Scheduler by Quickwork app from the drop-down. 
2. Choose the trigger event New scheduled event.
3. Set the Interval (for example, every 15 seconds) to determine how often the API should be tested.
4. Set the date and time of your choice in the Start At field and keep the Custom payload field empty.
   No authorization is required as this is an app created by Quickwork.

Using the Try-catch business logic

The Try-catch functionality is used to test whether the API endpoint functions correctly. The Try block contains the HTTP request, while the Catch block handles any exceptions.

Configuring the HTTP action under Try block

1. In the Steps section, click on the Business Logic button and choose Try Catch.
2. In the Try block, select HTTP from the App drop-down menu.
3. Select Send new request as an action.
4. Enter the name of the API in the Request name field. For example, User Login API.
5. Select application/json as Request content type.
6. Select POST as the Request HTTP method.
7. Enter the API endpoint in the Request URL field, which is obtained from the endpoint configured in API collections under Tools > API Management in Quickwork.
   
   
   
   
8. Now, scroll down to the Request headers object. 
9. Enter apiKey as a name in the Header name field.
10. Specify the actual API key in the Header Value field, which can be obtained from the access profile in Clients under Tools > API Management in Quickwork.
    

Configuring the Logger action under Catch block

1.  Select Logger from the App drop-down menu in the Catch block.
2. Select Log a Message as an action.
3. Drag and drop the Error data pill from the Catch action under Data Tree Output. This logs the error for debugging purposes.
   
   
   

Introducing the If Else condition 

The If Else condition is used to validate the API status and send appropriate notifications.

Configuring the If condition

1. Click the + icon, click the Business Logic option, and select If Else Condition.
2. The If Else Condition block will appear with the pre-indented action bars.
3. In the Left Value field, drag and drop the Status Code data pill from the HTTP | Send new request response under Data Tree Output.
4. Select the Equals condition from the drop-down menu in the Condition field.
5. In the Right Value field, enter 200, indicating success.

Configuring the Slack action under If block

1. Click on the Please choose an action bar under the If block.
2. Choose the Slack app from the drop-down menu in the App field.
3. Select the action, Send message to a channel, from the drop-down menu in the Action field.
4. Click the Link account button to connect Slack with Quickwork. 
5. In the Channel toggle field, choose the Select from list operation and then select the channel name in which you want the message to appear. For example, mypersonal.
6. Enter the message in the Message field to be displayed on your Slack channel. For example, The User Login API is working fine.
7. Leave all the other input fields empty.

Configuring the Slack action under Else block

1. Click on the Please choose an action bar under the Else block.
2. Choose the Slack app from the drop-down menu in the App field.
3. Select the action, Send message to a channel, from the drop-down menu in the Action field.
4. In the Channel toggle field, choose the Select from list operation and then select the channel name in which you want the message to appear. E.g., mypersonal.
5. Enter the message in the Message field to be displayed on your Slack channel. For example,
   The User Login API is malfunctioned. It might have stopped functioning due to following three reasons:
   1. Incorrect API endpoint.
   2. Incorrect API key.
   3. Bad gateway.
6. Leave all the other input fields as empty.

The Try-catch journey is now successfully configured. It must look like this:

Executing the journey

1. Save the changes of the journey and click Save & Start.
2. Observe the Slack notifications every 15 seconds for updates on the API status.

3. If the API fails, the error is logged in the Catch block, and a notification is sent via Slack.

By using the Try-catch block, you can effectively monitor your API endpoints, handle errors proactively, and ensure seamless workflow execution.