Alerts
      Back to home
      1. AlphaX Help Center
      2. AlphaX Cloud™
      3. Alerts

      Configuring HTTP Event Actions in AlphaX

      AlphaX allows you to configure HTTP actions to interact with external systems whenever an alert condition is met. This guide provides detailed instructions on setting up HTTP event actions.

      HTTP Actions View

      HTTP Event Actions Settings

      1.  Enable HTTP Action
        •  Check the box next to HTTP to activate the HTTP action.
      2.  HTTP URL
        •  Purpose: Specifies the endpoint URL that the HTTP request will be sent to.
        •  Example: https://xxx.mysite.com/createMyWorkorder
        •  Ensure the URL is correctly formatted and accessible from the AlphaX system.
      3.  Headers
        •  Purpose: Allows you to include additional information in the HTTP request header.
        •  Example Header
          •  Key: token
          •  Value: abcxxx
        •  Add headers by clicking the + Add Header button. You can add multiple headers as needed for authentication or other purposes.
      4.  HTTP Method
        •  Purpose: Specifies the format and encoding of the HTTP request body.
        •  Options,
          •  Plain text: Sends the data as plain text.
          •  Multipart Form: Sends the data as a multipart form, typically used for file uploads.
          •  x-www-form-urlencoded: Sends the data as key-value pairs encoded in the URL.
          •  JSON: Sends the data in JSON format, commonly used for APIs.
        •  Select the appropriate method based on the requirements of the receiving endpoint.

      NOTE: POST body is provided in standard AlphaX API format with 2 additional objects embedded. One object contains the matched condition data. The second object contains AI descriptions and information (If selected). See Data Format Here

      Example Configuration

      Scenario: Creating a Work Order

      •  HTTP URL: https://xxx.mysite.com/createMyWorkorder
      •  Headers:
        •  Key: token
        •  Value: abcxxx
      •  HTTP Method: JSON

      Steps to Configure

      1.  Activate HTTP Action
        •  Ensure the HTTP action checkbox is checked.
      2.  Enter the HTTP URL
        •  Type the endpoint URL in the HTTP URL field.
      3.  Add Headers
        •  Click + Add Header to add a new header.
        •  Enter the header key (token) and value (abcxxx).
        •  Add more headers if necessary by repeating the process.
      4.  Select HTTP Method
        •  Choose the method that matches the expected input format of your endpoint. For example, select JSON if the endpoint expects JSON formatted data.

      Usage Tips

      •  Authentication: Use headers to include tokens or API keys for authenticated requests.
      •  Data Formatting: Ensure the data sent in the HTTP request matches the expected format of the endpoint to avoid errors.
      •  Testing: Test the HTTP action with your endpoint to confirm it works as expected before relying on it for critical alerts.

      By configuring HTTP event actions, you can seamlessly integrate AlphaX with external systems, automating workflows such as creating work orders, logging events, or triggering additional processes. This enhances the responsiveness and efficiency of your operations.