Skip to main content

Run standalone workflows with the API

You can run a standalone workflow using the Workflow API. Standalone workflows can be run using RESTful HTTP POST requests in JSON format.

Run a standalone workflow using the Workflow API

To run a standalone workflow using the API:

  1. Navigate to Correlate & Automate > Workflow Engine, then click either the Alert Workflows or the Incident Workflows tab.

  2. Select your workflow from the list and open it.

  3. Under Workflow API, click Show:

    workflowAPIshow.png

  4. Copy the Workflow Endpoint URL. You can run the workflow from anywhere using the endpoint.

    You will need to provide an Incident Management API key in the request header, as well as the following attributes in the payload of the POST request. To learn about creating a new API key, see Create an API key:

    • ids: The IDs of the alerts or incidents that the workflow will process. This field is required.

    • workflow_id: The ID of the workflow that you want to run. You can find the ID of the current workflow in the example payload provided in the UI.

    • workflow_context: Declare workflow context variables and values that will be made available to the workflow during execution.

      For example, { retail: "card-type" } corresponds to the following workflow context variable: workflowContext.retail = "card-type"

    Below is an example of a cURL request invoking a single standalone workflow run request for incidents:

    curl "https://api.dev.moogsoft.cloud/v1/incident-workflows/standalone" \
-H "Content-Type: application/json" \
-H 'apiKey: 12345abcde67890fghij12345klmnop67890qrstuv' \
-d '{
    "ids": [101]
    "workflow_id": 99da2aa0f1dd3b1e348bbbb,
    "workflow_context": {
        "retail": "card-type"
    }
}'

  5. Compose and send your API request using the copied endpoint.

Standalone workflow API example

Suppose that you want to automate the closure of alerts, but only if the alert has been assigned to someone and has a severity of "Clear." You can use a Workflow API call to run a standalone alert workflow that checks these conditions and closes the alert:

  1. Create a new standalone alert workflow:

    1. Navigate to Correlate & Automate > Workflow Engine, then click the Alert Workflows tab.

    2. Click the Standalone Workflows tab.

    3. Click Add Workflow and provide a name for the workflow. Optionally, provide a description.

    4. Enter the following for the workflow trigger filter: assignee != NULL AND severity = Clear

    5. Click Add Action, select the Set Status action and then click Add Selected Action.

    6. Set the Status to "Closed."

    7. Save and Enable the workflow.

  2. Get the workflow endpoint URL:

    1. In the page for your standalone alert workflow, under Workflow API, click Show.

    2. Copy the Workflow Endpoint. You can run the workflow from anywhere using the endpoint.

      You will need to provide an Incident Management API key in the request header, as well as the following attributes in the payload of the POST request. To learn about creating a new API key, see Create an API key.

  3. Compose and send your API request using the copied endpoint, providing all required fields. Make sure your requests are RESTful HTTP POST requests formatted in JSON.

Without a standalone workflow, you would need to perform multiple API calls to check each condition and close the alert.

In this section: