Custom Flow Action Help Context

tiguin2798
Tera Guru

Hey Devs,

 

I have created a custom flow action that users can utilize to update a specific variable on catalog items prior to it getting passed to a mail script I've created. I have created a template for how users should utilize the input variables on this custom flow action and would like to show it in the help context. But, I am not seeing a way to add content in the help section here.

 
 
 

I really would love to have the help context as junior developers may not understand how flow inputs work or how to format their script for the inputs. For this I have created some help text and a script template I would like to share when devs click the help icon for the action.

 

I have tried adding text in the "hint" sections of the input variables for my action as well as tried adding a description/action annotation in the flow properties but nothing shows in the help section or on the action itself in flow.

Any help is appreciated!

image.pngimage.png

1 REPLY 1

Naveen20
ServiceNow Employee

The Help panel on custom Flow Designer actions is wired to ServiceNow's product documentation system — there's no field on the action definition that feeds into it for custom actions.

The Action Annotation and Description are just metadata visible in Action Designer, not the Help sidebar. Hints on inputs should show as info icons when configuring the action in a flow — make sure you've published after adding them, as draft changes won't appear for consumers.

For workarounds, you have a few options. You can create Embedded Help records (sys_embedded_help_content / sys_embedded_help_qualifier) matched to your action's Flow Designer URL context — this is the closest to populating that native panel. Alternatively, add a read-only "Instructions" input on the action itself with your script template as the default value so devs see it inline. Or create a Knowledge Base article and reference it in your input hints.