[Alerting v2] Create workflow extension service by adcoelho · Pull Request #267924 · elastic/kibana

adcoelho · 2026-05-06T09:58:57Z

Closes https://github.com/elastic/rna-program/issues/446

Summary

This PR creates a new WorkflowExtensionsService and does the wiring for registering workflow triggers and steps in the alerting v2 plugin.

How registration works

I created a README with this information, but:

Define a shared trigger definition in common (id + eventSchema) with Zod.
Register it on the server in server/lib/workflow_extensions/register_trigger_definitions.ts via registerTriggerDefinitions(service), which calls WorkflowExtensionsService.registerTriggerDefinitions(...).
Define a public trigger definition (PublicTriggerDefinition) with UI metadata (title, description, icon, docs).
Register it on the public side in public/lib/workflow_extensions/register_trigger_definitions.ts via registerTriggerDefinitions(service).
Add/update the trigger schema hash in:
- src/platform/plugins/shared/workflows_extensions/test/scout/api/fixtures/approved_trigger_definitions.ts

To confirm a trigger was created correctly:

How to visualize this in the UI

Start Kibana normally (your local dev workflow).
Go to Management -> Workflows.
Create/edit a workflow and open trigger selection.
Look for your trigger title
Open its docs panel; you should see the configured description/example from translations.ts.

infra-vault-gh-plugin-prod · 2026-05-06T09:59:03Z

Pinging @elastic/response-ops (Team:ResponseOps)

kdelemme

I'm very confused by the duplicated services

kdelemme · 2026-05-06T12:37:50Z

+  ) {}
+
+  public registerStepDefinitions(stepDefintions: ServerStepDefinitionOrLoader[]): void {
+    stepDefintions.forEach((stepDefinition) =>


Suggested change

stepDefintions.forEach((stepDefinition) =>

stepDefinitions.forEach((stepDefinition) =>

kdelemme · 2026-05-06T12:38:46Z

+  registerPublicTriggerDefinitions(triggerDefinitions: PublicTriggerDefinition[]): void;
+}
+
+export class WorkflowExtensionsService implements WorkflowExtensionsPublicServiceContract {


I don't understand we have two WorkflowExtensionsService ?

kdelemme · 2026-05-06T12:41:01Z

@@ -0,0 +1,42 @@
+# Alerting V2 workflows_extensions integration


can we add an entry for defining a step definition?

kdelemme

Sorry I missed the obvious public/server shenanigans. Would love a full example in the readme for the step definition but not blocking. I think #266668 will use this.

adcoelho · 2026-05-06T12:53:57Z

Sorry I missed the obvious public/server shenanigans. Would love a full example in the readme for the step definition but not blocking. I think #266668 will use this.

I tested this with a mock trigger but did not include that code in the PR. I will open a PR next for an "assign user to episode trigger registration". That should also help. Thanks for the review!

kibanamachine · 2026-05-06T13:25:42Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 929f182

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`alertingVTwo`	981	983	+2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`alertingVTwo`	43.6KB	44.0KB	+396.0B

History

💔 Build #438644 failed fabf51a

cc @adcoelho

cnasikas · 2026-05-06T13:59:51Z

I take a look at the PR, and I would like to discuss/suggest some changes:

I think we should separate the setup from the emitting in the service. It is ok to have only functions for setup, as we do with registerSavedObjects and registerFeaturePrivileges.
The service should have only the emitEvent: (triggerId: string, payload: Record<string, unknown>) => Promise<void>.
The constructor should accept the workflow client already instantiated with @inject as we do with the ES and SO client in the other services.
Put one README in x-pack/platform/plugins/shared/alerting_v2/public/lib/workflow_extensions for public and one in x-pack/platform/plugins/shared/alerting_v2/server/lib/services/workflow_extensions_service/tokens.ts for server. You can update the x-pack/platform/plugins/shared/alerting_v2/README.md with a paragraph that points to the two files and explains why and how they wire together.

Closes elastic/rna-program#446 ## Summary This PR creates a new `WorkflowExtensionsService` and does the wiring for registering workflow triggers and steps in the alerting v2 plugin. ## How registration works I created a README with this information, but: 1. Define a shared trigger definition in `common` (`id` + `eventSchema`) with Zod. 2. Register it on the server in `server/lib/workflow_extensions/register_trigger_definitions.ts` via `registerTriggerDefinitions(service)`, which calls `WorkflowExtensionsService.registerTriggerDefinitions(...)`. 3. Define a public trigger definition (`PublicTriggerDefinition`) with UI metadata (title, description, icon, docs). 4. Register it on the public side in `public/lib/workflow_extensions/register_trigger_definitions.ts` via `registerTriggerDefinitions(service)`. 5. Add/update the trigger schema hash in: - `src/platform/plugins/shared/workflows_extensions/test/scout/api/fixtures/approved_trigger_definitions.ts` To confirm a trigger was created correctly: How to visualize this in the UI 1. Start Kibana normally (your local dev workflow). 2. Go to Management -> Workflows. 3. Create/edit a workflow and open trigger selection. 4. Look for your trigger title 5. Open its docs panel; you should see the configured description/example from translations.ts. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

@Inject

## Summary [This PR addresses this comment.](#267924 (comment)) > - I think we should separate the setup from the emitting in the service. It is ok to have only functions for setup, as we do with registerSavedObjects and registerFeaturePrivileges. > - The service should have only the emitEvent: (triggerId: string, payload: Record<string, unknown>) => Promise<void>. > - The constructor should accept the workflow client already instantiated with @Inject as we do with the ES and SO client in the other services. > - Put one README in x-pack/platform/plugins/shared/alerting_v2/public/lib/workflow_extensions for public and one in x-pack/platform/plugins/shared/alerting_v2/server/lib/services/workflow_extensions_service/tokens.ts for server. You can update the x-pack/platform/plugins/shared/alerting_v2/README.md with a paragraph that points to the two files and explains why and how they wire together.

@Inject

## Summary [This PR addresses this comment.](elastic#267924 (comment)) > - I think we should separate the setup from the emitting in the service. It is ok to have only functions for setup, as we do with registerSavedObjects and registerFeaturePrivileges. > - The service should have only the emitEvent: (triggerId: string, payload: Record<string, unknown>) => Promise<void>. > - The constructor should accept the workflow client already instantiated with @Inject as we do with the ES and SO client in the other services. > - Put one README in x-pack/platform/plugins/shared/alerting_v2/public/lib/workflow_extensions for public and one in x-pack/platform/plugins/shared/alerting_v2/server/lib/services/workflow_extensions_service/tokens.ts for server. You can update the x-pack/platform/plugins/shared/alerting_v2/README.md with a paragraph that points to the two files and explains why and how they wire together.

Add workflow extension service to alerting v2.

fabf51a

adcoelho requested a review from kdelemme May 6, 2026 09:58

adcoelho self-assigned this May 6, 2026

adcoelho requested a review from a team as a code owner May 6, 2026 09:58

adcoelho added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// Feature:AlertingV2 labels May 6, 2026

adcoelho and others added 2 commits May 6, 2026 14:06

Merge branch 'main' into alerting-v2-workflow-triggers

76fa42b

Changes from node scripts/regenerate_moon_projects.js --update

929f182

kdelemme mentioned this pull request May 6, 2026

[Alerting v2] [Rule Doctor] Run API and deduplication workflow #266668

Open

6 tasks

kdelemme reviewed May 6, 2026

View reviewed changes

kdelemme approved these changes May 6, 2026

View reviewed changes

adcoelho enabled auto-merge (squash) May 6, 2026 12:54

adcoelho merged commit f743eb6 into elastic:main May 6, 2026
66 checks passed

kibanamachine added the v9.5.0 label May 6, 2026

adcoelho mentioned this pull request May 8, 2026

[Alerting V2] Updates to the WorkflowService #268419

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting v2] Create workflow extension service#267924

[Alerting v2] Create workflow extension service#267924
adcoelho merged 3 commits into
elastic:mainfrom
adcoelho:alerting-v2-workflow-triggers

adcoelho commented May 6, 2026

Uh oh!

infra-vault-gh-plugin-prod Bot commented May 6, 2026

Uh oh!

kdelemme left a comment

Uh oh!

kdelemme May 6, 2026

Uh oh!

kdelemme May 6, 2026

Uh oh!

kdelemme May 6, 2026

Uh oh!

kdelemme left a comment

Uh oh!

adcoelho commented May 6, 2026

Uh oh!

kibanamachine commented May 6, 2026

Uh oh!

Uh oh!

cnasikas commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	stepDefintions.forEach((stepDefinition) =>
	stepDefinitions.forEach((stepDefinition) =>

		@@ -0,0 +1,42 @@
		# Alerting V2 workflows_extensions integration

Conversation

adcoelho commented May 6, 2026

Summary

How registration works

Uh oh!

infra-vault-gh-plugin-prod Bot commented May 6, 2026

Uh oh!

kdelemme left a comment

Choose a reason for hiding this comment

Uh oh!

kdelemme May 6, 2026

Choose a reason for hiding this comment

Uh oh!

kdelemme May 6, 2026

Choose a reason for hiding this comment

Uh oh!

kdelemme May 6, 2026

Choose a reason for hiding this comment

Uh oh!

kdelemme left a comment

Choose a reason for hiding this comment

Uh oh!

adcoelho commented May 6, 2026

Uh oh!

kibanamachine commented May 6, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Page load bundle

History

Uh oh!

Uh oh!

cnasikas commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants