Skip to main content

HTTP Endpoint Monitoring

note

This template is only available on the Developer Playground in Launch Pad.

This endpoint monitoring template checks the health of a specified HTTP endpoint and sends an email alert if the endpoint is unreachable or returns an unexpected status code.

This template serves as a quickstart for building monitoring workflows. You can use this as a foundation and extend it with features such as alternative notification channels, and more.

Conductor features used​

This template utilizes the following Conductor features:

How to use the template​

  1. Import the template from Launch Pad.
  2. Configure and verify the sender email in SendGrid.
  3. Run workflow.
Prerequisites

This template uses SendGrid integration. Ensure that you obtain the SendGrid API key from your SendGrid account.

Step 1: Import the template​

The endpoint monitoring template is available only in the Developer Playground on Launch Pad.

To import the template:

  1. Log in to Developer Playground.
  2. Go to Launch Pad on the left navigation menu.
  3. Select HTTP Endpoint Monitoring, then select Import.
  4. In Required Integrations > SendGrid email, either select an existing SendGrid integration or create a new one.
  5. (If creating a new integration) Select Create integration from the dropdown list.
    1. Enter an Integration name.
    2. In API Key, paste the API key copied from the SendGrid account.
    3. Enter a Description for the integration.
    4. Select Save.
  6. Select Continue Workflow to import the workflow.

The HTTP_EndPoint_Monitoring workflow is now imported and ready for use.

HTTP Endpoint Monitoring workflow

Understand the workflow logic​

This section explains the workflow logic and how to execute it.

Workflow inputs:

  • URL–The HTTP(S) endpoint to be monitored using the workflow.
  • sender_email–The sender email address to display the alert.
  • customer_email–The recipient email address for alert notifications.

Example input payload:

{
 "URL": "https://orkes.io/",
 "sender_email": "verified-sender@example.com",
 "customer_email": "alerts@example.com"
}

Workflow logic:

  • The workflow begins with an HTTP task that sends a GET request to the specified endpoint.
  • Next, the Switch task evaluates the HTTP status code to determine if the response indicates a success or failure.
    • If the response status code is 200, a Set Variable task sets a success flag, and the workflow completes.
    • For any other response or failure (e.g., DNS error), the Switch task sends execution to the defaultCase path.
  • In the defaultCase path, a SendGrid task sends an email notification using the provided sender and recipient addresses. The subject and message content indicate that the endpoint health check failed.
  • After sending the alert, a Terminate task ends the workflow with the reason “did not receive 200 status code.”

Step 2: Configure and verify sender email in SendGrid​

For the SendGrid integration to work, the sender email must be verified.

To verify the sender email:

  1. Go to Marketing > Senders from the left menu on your SendGrid account.
  2. Select Create New Sender.
  3. Enter the following mandatory parameters:
  • From Name
  • From Email Address
  • Reply to
  • Company Address
  • City
  • Country
  • Nickname

Adding a sender in SendGrid portal

  1. Select Save.

This saves the sender to your SendGrid portal and sends a verification email. Once the sender clicks the verification link, the sender’s status is updated to ‘verified’ within the SendGrid portal.

Sender verified in SendGrid portal

Step 3: Run the workflow​

To run the workflow:

  1. From the HTTP_EndPoint_Monitoring workflow definition, go to the Run tab.
  2. Enter the Input Params. For example:
{
 "URL": "https://orkes.io/", 
 "sender_email": "<YOUR-SENDGRID-VERIFIED-EMAIL>",
 "customer_email": "<ALERT-RECEIVER-EMAIL>" 
}
  1. Select Execute.

Sample execution for HTTP endpoint monitoring workflow

Workflow output​

If the monitored HTTP endpoint is healthy, the workflow follows the success path (200) and completes successfully.

Sample workflow executed successfully

If the endpoint is down, the workflow follows the defaultCase, sends an alert email, and ends with a termination reason.

Endpoint monitoring template’s default execution path

The user receives an alert email through SendGrid.

Alert email received via SendGrid

Workflow modifications​

This template provides a starting point for customizing the workflow to your needs. You can add additional steps, such as:

  • Add a different provider (like Opsgenie for incident notifications, Slack/Microsoft Teams notification, or integrate with Jira/Zendesk via API ).
  • Modify email content based on your requirements and next steps.
  • Add any escalation steps.