External API Event

Configure External API Event

To set up an external API event:

1. Title: Enter a descriptive title for the API event.
2. Description: Provide a description of the API interaction.
3. Method: Specify the HTTP method to use (e.g., GET, POST).
4. URL: Enter the URL of the external API endpoint.
5. Headers: Set the necessary headers for the API request.
6. Query Parameters: Define any query parameters required for the request.

Steps:

1. Alice Johnson is setting up an "External API" event.
2. Enter the following details:
   • Title: Get User Data
   • Description: Fetch user data from external API
   • Method: GET
   • URL: https://api.example.com/users
3. Set the headers:
   • Key: Authorization, Value: Bearer <token>
   • Key: Content-Type, Value: application/json
4. Set the query parameters:
   • Key: userId, Value: 12345
5. Save the configuration.

Outcome: The External API event will be configured with the specified title, description, method, URL, headers, and query parameters.

Validate External API Configuration

To ensure the external API event is configured correctly:

1. Action: Review the configured details.

Expected Outcome:

• Alice Johnson should see the configured values for:
  • Title
  • Description
  • Method
  • URL
  • Headers
  • Query Parameters

Trigger External API Event

To activate the external API event based on predefined conditions:

1. Given: The "External API" event is configured and the trigger conditions are met (e.g., user data needs to be fetched).

2. When: The trigger conditions are fulfilled.

Expected Outcome:

• The system should send a request to:
  • URL: https://api.example.com/users
  • Method: GET
  • Headers:
    • Authorization: Bearer <token>
    • Content-Type: application/json
  • Query Parameters:
    • userId: 12345

Validate API Response

To verify the response from the external API:

1. Action: Check the API response after triggering the event.

Expected Outcome:

• The response should contain the expected user data:
  • Response Code: 200
  • Response Body:

    {
      "id": 12345,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }