---
title: Run a workflow
source: https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/actions-catalog/newrelic/notification/newrelic-workflowautomation-startworkflowrun
---

The action identifier is `newrelic.workflowAutomation.startWorkflowRun`.

Runs a workflow through the NerdGraph API.

## Inputs

The following table describes all available input fields for this action.

| Input                   | Type   | Description                                                                                                                    | Example                                |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- |
| **definitionName**      | String | **Required.** Name of the workflow definition.                                                                                 |                                        |
| **definitionScopeType** | String | **Optional.** Scope type of the workflow definition. Must be either `ACCOUNT` or `ORGANIZATION`.                               |                                        |
| **definitionVersion**   | Int    | **Optional.** Version of the workflow definition.                                                                              |                                        |
| **idempotencyKey**      | String | **Optional.** A valid UUID to ensure idempotency of the request. The server validates this format and rejects non-UUID values. | `f47ac10b-58cc-4372-a567-0e02b2c3d479` |
| **workflowInputs**      | List   | **Optional.** Key-value pairs to pass as inputs to the workflow definition.                                                    |                                        |
| **runScopeType**        | String | **Required.** Scope type for the run. Must be `ACCOUNT`.                                                                       | `ACCOUNT`                              |
| **runScopeId**          | String | **Required.** Account ID for the run scope.                                                                                    | `12345678`                             |
| **selectors**           | List   | **Optional.** Selectors to extract specific fields from the output.                                                            |                                        |

## Outputs

The following table describes all output fields returned by this action.

| Output           | Type    | Description                               |
| ---------------- | ------- | ----------------------------------------- |
| **runId**        | String  | Unique identifier for the workflow run.   |
| **success**      | Boolean | `true/false`                              |
| **errorMessage** | String  | Error message if the run failed to start. |

## Example

| Workflow example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ```yaml steps:   - name: startHealthyHeartbeat     type: action     action: newrelic.workflowAutomation.startWorkflowRun     version: 1     inputs:       definitionName: "heartbeat_newrelicIngestSendEvents_10062025"       definitionVersion: 1       scopeType: "ACCOUNT"       definitionScopeType: "d34568b7-ee0b-4191-b663-7b2925b0de5b"       workflowInputs:         - key: "cellName"           value: "stg-joint-effort"       runScopeType: "ACCOUNT"       runScopeId: "11544325" ``` |
