Skip to content

Commit 604d90a

Browse files
authored
Merge pull request #22250 from newrelic/update-actions-catalog
Updated the actions catalog and restructured it
2 parents 6de4924 + c19b9b9 commit 604d90a

File tree

63 files changed

+10689
-27360
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+10689
-27360
lines changed

src/content/docs/alerts/get-notified/destinations.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ The supported destination platforms include:
3030
* AWS EventBridge: Available in [workflows](/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/).
3131
* PagerDuty: Available in [workflows](/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/).
3232
* New Relic Mobile Push: Available in [workflows](/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/).
33-
* Microsoft Teams: Available in [workflows](/docs/alerts/get-notified/microsoft-teams-integrations/).
33+
* Microsoft Teams: Available in [workflows](/docs/alerts/get-notified/microsoft-teams-integrations/).
34+
* **Workflow Automation**: Available in [workflows](/docs/alerts-applied-intelligence/applied-intelligence/incident-workflows/incident-workflows/). Triggers [automated incident response workflows](/docs/workflow-automation/setup-and-configuration/create-destinations#trigger-from-alerts) when alert conditions are breached.
3435

3536
For more on these and other destinations, see [notification integrations](/docs/alerts-applied-intelligence/notifications/notification-integrations).
3637

src/content/docs/workflow-automation/create-a-workflow-automation/create-your-own.mdx

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ When templates don't fit your needs, [Create Your Own](https://onenr.io/0OQM47Kg
2020

2121
This guide shows you how to build workflows using concepts and a complete example. Choose your learning path:
2222

23-
- **Learn core concepts first** Read [Core concepts](#core-concepts) and [Workflow patterns](#workflow-patterns) to understand the fundamentals, then apply them
24-
- **Follow the example** Jump to [Example walkthrough](#example-walkthrough) to build an EC2 auto-resize workflow step-by-step
25-
- **Reference patterns** Use the [Workflow patterns](#workflow-patterns) section as a quick reference when building your own workflows
23+
- **Learn core concepts first**: Read [Core concepts](#core-concepts) and [Workflow patterns](#workflow-patterns) to understand the fundamentals, then apply them
24+
- **Follow the example**: Jump to [Example walkthrough](#example-walkthrough) to build an EC2 auto-resize workflow step-by-step
25+
- **Reference patterns**: Use the [Workflow patterns](#workflow-patterns) section as a quick reference when building your own workflows
2626

2727
<Callout variant="tip">
2828
**New to workflows?** Start with core concepts, then follow the example. The EC2 workflow demonstrates all key patterns in a real-world scenario.
@@ -116,7 +116,7 @@ Understand these fundamentals before you build:
116116

117117
<tr>
118118
<td>
119-
Loops
119+
[Loops](/docs/workflow-automation/workflow-examples#loop-structure)
120120
</td>
121121

122122
<td>
@@ -134,7 +134,7 @@ Understand these fundamentals before you build:
134134
</td>
135135

136136
<td>
137-
Mandatory field for loop functions to define iteration count
137+
Required parameter for loop functions to define iteration count
138138
</td>
139139

140140
<td>
@@ -183,7 +183,7 @@ For detailed error handling patterns, see [Best practices](/docs/workflow-automa
183183
Build your first workflow in five steps:
184184

185185
1. Navigate to **[one.newrelic.com](https://one.newrelic.com) > All Capabilities > Workflow Automation** and select **[Create Your Own](https://onenr.io/0OQM47KgxjG)**
186-
2. Define parameters for credentials (from secrets manager: `${{ :secrets:keyName }}`), configuration (regions, instance types), and runtime data (account IDs, alert IDs)
186+
2. Define parameters for credentials (from [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials): `${{ :secrets:keyName }}`), configuration (regions, instance types), and runtime data (account IDs, alert IDs)
187187
3. Drag actions from the [catalog](/docs/workflow-automation/setup-and-configuration/actions-catalog/actions-catalog), connect them with `${{ .steps.stepName.outputs.field }}` syntax to pass data
188188
4. Insert switches for conditional branching, loops for processing lists or polling, approval gates for human decisions
189189
5. Run after each section to catch errors early, then [start or schedule](/docs/workflow-automation/create-a-workflow-automation/start-schedule) your workflow
@@ -218,6 +218,8 @@ Four essential patterns handle most automation scenarios. Each pattern is demons
218218
219219
**Use loops when:** Processing multiple items or repeating actions
220220
221+
For detailed information about loop structure, parameters, and advanced usage (including break/continue), see [Loop structure](/docs/workflow-automation/workflow-examples#loop-structure).
222+
221223
**Key syntax:**
222224
```yaml
223225
# Send progress updates using range loop
@@ -242,7 +244,7 @@ Four essential patterns handle most automation scenarios. Each pattern is demons
242244

243245
### Approval gates and waiting
244246

245-
**Use approval gates when:** Human judgment needed before destructive operations or compliance sign-off required
247+
**Use approval gates when:** Human judgment is needed before destructive operations or compliance sign-off is required
246248

247249
**Key syntax:**
248250
```yaml
@@ -314,7 +316,7 @@ Before building this workflow, ensure you have:
314316
- **AWS**: Credentials with EC2 and Systems Manager permissions
315317
- **Slack**: Bot token and channel for notifications
316318
- **New Relic**: Alert condition monitoring EC2 CPU
317-
- **Secrets manager**: Configured (see [secrets management](/docs/infrastructure/host-integrations/installation/secrets-management/))
319+
- **Secrets manager**: Configured (see [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials))
318320

319321
### Workflow overview [#workflow-overview]
320322

@@ -332,10 +334,10 @@ This example demonstrates key patterns you'll use in custom workflows: querying
332334
**Skip if you're reading for concepts.** This table details the 12 parameters this workflow uses. You can reference it when building, but it's not essential for understanding the flow.
333335
</Callout>
334336

335-
This workflow requires credentials, configuration, and runtime context as inputs. Sensitive values come from secrets manager using `${{ :secrets:keyName }}` syntax.
337+
This workflow requires credentials, configuration, and runtime context as inputs. Sensitive values come from [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials) using `${{ :secrets:keyName }}` syntax.
336338

337339
**Input categories:**
338-
- **Authentication**: AWS and Slack credentials from secrets manager
340+
- **Authentication**: AWS and Slack credentials from [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials)
339341
- **Alert context**: Account ID and issue ID from New Relic
340342
- **Configuration**: Region, instance type, timezone, Slack channel
341343

@@ -370,7 +372,7 @@ This workflow requires credentials, configuration, and runtime context as inputs
370372
`${{ :secrets:awsAccessKeyId }}`
371373
</td>
372374
<td>
373-
AWS Access Key ID retrieved from secrets manager for authenticating with AWS services.
375+
AWS Access Key ID retrieved from [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials) for authenticating with AWS services.
374376
</td>
375377
</tr>
376378
<tr>
@@ -384,7 +386,7 @@ This workflow requires credentials, configuration, and runtime context as inputs
384386
`${{ :secrets:awsSecretAccessKey }}`
385387
</td>
386388
<td>
387-
AWS Secret Access Key retrieved from secrets manager. Pairs with the access key ID.
389+
AWS Secret Access Key retrieved from [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials). Pairs with the access key ID.
388390
</td>
389391
</tr>
390392
<tr>
@@ -606,7 +608,7 @@ Now let's build each part of the workflow. Each step includes the specific actio
606608
The workflow resizes the instance through AWS Systems Manager (SSM):
607609

608610
* **`createSsmDocument`**: Creates an SSM Automation document that stops the instance, modifies type, and restarts it.
609-
* **`generateIdempotencyToken`**: Creates a unique UUID. Prevents duplicate resizes if the workflow runs twice.
611+
* **`generateIdempotencyToken`**: Creates a unique UUID to prevent duplicate resizes if the workflow runs twice.
610612
* **`startResizing`**: Executes the SSM document with instance ID and new type.
611613
* **`progressLoop` (Loop)**: Posts Slack updates every 10 seconds (5 times total).
612614
* **`waitForCompletion`**: Polls SSM status with 2-minute timeout.

src/content/docs/workflow-automation/create-a-workflow-automation/start-schedule.mdx

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,22 @@ freshnessValidatedDate: never
1616
This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
1717
</Callout>
1818

19-
Once you've created a workflow, you can run it manually on demand or schedule it to run automatically at specific times. Both methods use the [NerdGraph API](/docs/apis/nerdgraph/get-started/nerdgraph-explorer) to trigger workflow execution.
19+
Once you've created a workflow, you can trigger it in three ways: from alerts, manually on demand, or on a schedule.
2020

2121
## Choose your trigger method
2222

2323
Select the right approach for your use case:
2424

25-
| **Use on-demand** | **Use scheduled** |
26-
|-------------------|-------------------|
27-
| Testing new workflows | Regular health checks |
28-
| Manual approval workflows | Periodic data processing |
29-
| Alert-triggered responses | Daily/weekly reports |
30-
| Ad-hoc maintenance tasks | Scheduled maintenance windows |
31-
| One-time operations | Recurring backups or cleanups |
25+
| **Trigger from alerts** | **Run on-demand** | **Run on schedule** |
26+
|------------------------|-------------------|---------------------|
27+
| Automated incident response | Testing new workflows | Regular health checks |
28+
| Auto-remediation (resize EC2, rollback) | Manual operations | Periodic data processing |
29+
| Enriched alert notifications | Ad-hoc maintenance | Daily/weekly reports |
30+
| **Setup**: [Configure as alert destination](/docs/workflow-automation/setup-and-configuration/create-destinations#trigger-from-alerts) | **API**: [StartWorkflowRun](#on-demand) | **API**: [CreateSchedule](#scheduled) |
31+
32+
<Callout variant="tip">
33+
**Alert-triggered workflows**: When alert conditions are breached, New Relic can automatically trigger workflows by configuring Workflow Automation as a destination. The `issueId` and `accountId` are passed automatically. See [Send notifications from workflows](/docs/workflow-automation/setup-and-configuration/create-destinations#trigger-from-alerts) for setup instructions.
34+
</Callout>
3235

3336
## Before you begin
3437

@@ -38,7 +41,7 @@ Before triggering workflows, ensure you have:
3841
- **Account ID**: Your New Relic account ID (found in [Account settings](/docs/accounts/accounts-billing/account-structure/account-id)).
3942
- **Workflow name**: The exact name from your workflow definition.
4043
- **Required inputs**: Values for any parameters your workflow expects.
41-
- **Secrets configured**: AWS credentials, Slack tokens, or other secrets stored in [secrets manager](/docs/infrastructure/host-integrations/installation/secrets-management/).
44+
- **Secrets configured**: AWS credentials, Slack tokens, or other secrets stored in [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials).
4245

4346
<Callout variant="tip">
4447
**New to workflows?** Create your first workflow before trying to trigger it. Start with [Use a template](/docs/workflow-automation/create-a-workflow-automation/use-a-template) for pre-built workflows.
@@ -95,9 +98,9 @@ The following workflow definition invokes an AWS Lambda function and logs the ou
9598
- message: 'The lambda function message output is:${{ .steps.invoke1.outputs.payload.body }}'
9699
```
97100
98-
To start this workflow, use the following NerdGraph mutation. Before running this mutation, ensure you've stored your AWS credentials using the `secretsManagementCreateSecret` mutation. For more information, see [Introduction to secrets management](/docs/apis/nerdgraph/examples/nerdgraph-secrets-management).
101+
To start this workflow, use the following NerdGraph mutation. Before running this mutation, ensure you've stored your AWS credentials using the `secretsManagementCreateSecret` mutation. For more information, see [secrets manager](/docs/workflow-automation/limitations-and-faq/workflow-best-practices/#secure-credentials).
99102

100-
```graphql
103+
```yaml
101104
mutation {
102105
workflowAutomationStartWorkflowRun(
103106
# Specify the account where the workflow is defined
@@ -165,7 +168,7 @@ Schedules use cron expressions to define when workflows run. Format: `minute hou
165168

166169
The following example schedules the `lambda1` workflow to run every day at 9 AM Eastern Time:
167170

168-
```graphql
171+
```yaml
169172
mutation {
170173
workflowAutomationCreateSchedule(
171174
# Specify the account where the workflow is defined

src/content/docs/workflow-automation/introduction-to-workflow.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ freshnessValidatedDate: never
1818

1919
Workflow Automation connects New Relic with your existing tools to automate incident response, infrastructure management, and operational tasks—without writing code. Build workflows that respond to alerts, integrate with AWS and Slack, manage approvals, and execute complex automation logic.
2020

21+
**Trigger workflows in three ways:**
22+
- **From alerts**: Automatically start workflows when alert conditions are breached (see [Send notifications from workflows](/docs/workflow-automation/setup-and-configuration/create-destinations#trigger-from-alerts))
23+
- **On demand**: Manually trigger workflows via API when needed
24+
- **On schedule**: Run workflows automatically at specific times using cron expressions
25+
2126
<img
2227
title="Create and manage workflows in New Relic"
2328
alt="Screenshot showing the workflow automation interface"

src/content/docs/workflow-automation/limitations-and-faq/workflow-best-practices.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Store all sensitive values in New Relic's secrets manager. Never hardcode creden
107107

108108
Store AWS credentials, API tokens, and passwords:
109109

110-
```graphql
110+
```yaml
111111
mutation {
112112
secretsManagementCreateSecret(
113113
scope: {type: ACCOUNT id: "YOUR_NR_ACCOUNT_ID"}

src/content/docs/workflow-automation/limitations-and-faq/workflow-limits.mdx

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,22 @@ freshnessValidatedDate: never
4040
<td>50KB</td>
4141
</tr>
4242
<tr>
43-
<td>No of Workflow definitions (Including all versions)</td>
43+
<td>No of Workflow definitions at account level(excluding versions count)</td>
4444
<td></td>
4545
<td>1000</td>
4646
</tr>
4747
<tr>
48-
<td>No of Workflow definitions at org level (including all versions)</td>
48+
<td>No of Workflow definitions at org level (excluding versions count)</td>
49+
<td></td>
50+
<td>1000</td>
51+
</tr>
52+
<tr>
53+
<td>No of versions per workflow definition at account level</td>
54+
<td></td>
55+
<td>1000</td>
56+
</tr>
57+
<tr>
58+
<td>No of versions per workflow definition at org level</td>
4959
<td></td>
5060
<td>1000</td>
5161
</tr>
@@ -67,7 +77,7 @@ freshnessValidatedDate: never
6777
<tr>
6878
<td>Length of a workflow input value</td>
6979
<td></td>
70-
<td>1000 characters</td>
80+
<td>1000 Characters</td>
7181
</tr>
7282
<tr>
7383
<td>Workflow concurrent runs (per account)</td>

0 commit comments

Comments
 (0)