Best practices: Action card names and descriptions

Follow these 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 use title case where the first letter of each word is capitalized. Don't include articles (definite or indefinite) or other words such as prepositions whenever possible.

For example, these are all proper names for action cards:

  • Create User

  • Delete File

  • Custom API Action

The following versions of the previous action card names aren't 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 incorrect.

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 use sentence case where only the first word is capitalized, unless the description includes names or proper nouns.

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

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

  • A description should be in the present tense.

For example, descriptions can be:

  • Update group details in Google Workspace.

  • Unassign a license from an Azure Active Directory user.

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

  • Updated group & details

  • Unassigns a License from a Azure Active Directory User