Best practices: Action card names and descriptions

This is an Early Access feature for existing Workflows users. To enable it, use the Early Access Feature Manager as described in Manage Early Access and Beta features.

Follow recommended best practices for assigning names and descriptions to action cards.

Name of an action card

The name for an action card is derived from the string that you enter in the Name your Flow dialog when you first save a new flow. You can prompt the Name your Flow dialog in one of two ways:

  • Click the Unnamed pencil icon in the upper banner of the Workflows designer canvas.

  • Click the Save button.

Names of action cards should be in title casing. The first letter of each word should be capitalized. Do not include articles (definite or indefinite) or other words such as prepositions whenever possible.

For example, proper names for action cards can be:

  • Create User

  • Delete File

  • Custom API Action

The following versions of the above listed action card names are not recommended:

  • Create a User

  • Delete a File

  • custom api action

If articles or prepositions are necessary for intuitive naming, include them as lowercase:

  • Add User to Group

  • List Users with Filter

In such examples, "To" or "With" are not correct.

Description of an action card

When you submit a connector's action card for review and publication in the public catalog, you must include a description. You can add a description in the Name your Flow dialog.

  • A card's description should be in sentence casing. Only the first word should be capitalized unless the description includes names or proper nouns.

  • A description should be one sentence in length only, and end with a period. When necessary, a description can contain a maximum of two sentences.

  • For improved searchability, a description should include the name of the service that's being integrated. For example, Okta, Salesforce, Box, Zoom.

  • A description should be in the present tense.

For example, descriptions can be:

  • Updates group details in Google Workspace.

  • Unassigns a license from a Microsoft O365 user.

The same descriptions use the wrong tense, improper capitalization, or punctuation:

  • Updated group details;

  • Unassigns a License from a Microsoft O365 User