PromptAction

Represents how the user interacted with the in-app guidance prompt or walkthrough.

Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions.

Introduced in API version 46.0.

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Indicates the date the in-app guidance was last displayed to the user.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Indicates the last user interaction.
  • Possible values:
    • CustomAction — CustomAction
    • Dismiss — Dismiss
    • Error — Error
    • Finish — Finish — (walkthroughs only)
    • NoAction — NoAction
    • NotSeen — NotSeen
    • Snooze — Snooze
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Indicates the date the in-app guidance was last interacted with.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the in-app guidance.
  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    ID of the PromptVersion object.

    This is a relationship field.

  • Relationship name: PromptVersion

  • Relationship type: relationship

  • Refers to: PromptVersion

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The timestamp for when the user’s snooze request expires. The user won’t see the prompt again until they navigate to the page after the snooze time expires.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: Indicates the total number of steps in the walkthrough.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: Indicates the number of the last step the user viewed or interacted with in a walkthrough. Maximum value is 10.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Number of times that the user took action on the in-app guidance.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Number of times that the user dismissed the in-app guidance.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Number of times that the in-app guidance was displayed to the user.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The total number of times the user snoozes the prompt.
  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    ID of the user.

    This is a relationship field.

  • Relationship name: User

  • Relationship type: relationship

  • Refers to: User

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.