Timed Out Trigger Setup

Timed Out Triggers are used to handle scenarios where API requests exceed a specified time limit. These triggers help in monitoring and managing API performance by triggering actions when requests take too long.

Overview

Timed Out Triggers are configured to monitor the response time of API requests. If an API request exceeds the defined time limit, the trigger activates and performs the specified action.

Configuring Timed Out Triggers

Configure Timed Out Trigger for GET Method with a 10-Second Time Limit

To set up a timed out trigger for a GET request:

1. Title: Enter a title for the trigger.
2. Description: Provide a description of the trigger.
3. API Method: Select "GET."
4. API URL: Enter the API endpoint (e.g., api/v1/users).
5. Time Limit: Set the time limit to 10 seconds.

Outcome: The trigger will activate if a GET request to api/v1/users takes longer than 10 seconds.

Configure Timed Out Trigger for POST Method with a 5-Second Time Limit

To set up a timed out trigger for a POST request:

1. Title: Enter a title for the trigger.
2. Description: Provide a description of the trigger.
3. API Method: Select "POST."
4. API URL: Enter the API endpoint (e.g., api/v1/users).
5. Time Limit: Set the time limit to 5 seconds.

Outcome: The trigger will activate if a POST request to api/v1/users takes longer than 5 seconds.

Configure Timed Out Trigger for PUT Method with a 15-Second Time Limit

To set up a timed out trigger for a PUT request:

1. Title: Enter a title for the trigger.
2. Description: Provide a description of the trigger.
3. API Method: Select "PUT."
4. API URL: Enter the API endpoint with path parameters (e.g., api/v1/users/id).
5. Time Limit: Set the time limit to 15 seconds.

Outcome: The trigger will activate if a PUT request to api/v1/users/id takes longer than 15 seconds.

Configure Timed Out Trigger for DELETE Method with a 20-Second Time Limit

To set up a timed out trigger for a DELETE request:

1. Title: Enter a title for the trigger.
2. Description: Provide a description of the trigger.
3. API Method: Select "DELETE."
4. API URL: Enter the API endpoint with path parameters (e.g., api/v1/users/id).
5. Time Limit: Set the time limit to 20 seconds.

Outcome: The trigger will activate if a DELETE request to api/v1/users/id takes longer than 20 seconds.

Validate Timed Out Trigger Configuration

To review and validate the configured timed out trigger:

1. Action: Review the configured details.
2. Expected Outcome: The configured values should include:
   • Title
   • Description
   • API Method
   • API URL
   • Time Limit

Verify Timed Out Trigger Activation

To verify that a timed out trigger activates correctly:

1. Action: Make an API request that exceeds the specified time limit.
2. Expected Outcome: The timed out trigger should be activated and verified as working correctly.

Summary

Timed Out Triggers are essential for managing API performance and ensuring timely responses. By configuring and validating these triggers, users can effectively monitor and handle cases where API requests exceed expected response times.