Skip to content

Agentforce

Onboarded™ provides Invocable Apex Actions for Agentforce agents. Most of them can also be called from Flow and Apex. Get Onboarded™ Task Unlock Sections is intended for Agentforce agents only. Some actions are gated: the mapping lookup actions check for an Onboarded™ permission set, and Get Onboarded™ Task Unlock Sections requires the Onboarded™ Agentforce Access permission set. See the Access needed column below. To add one to an agent, open Agent Builder, choose the agent's Topic, add an Action, select Apex, and search for the action's name.

ActionWhat it doesRead-only?Access needed
Get Onboarded™ Object MappingsTells the agent which Salesforce object is mapped to each Onboarded™ object type (Employee, Employer, Client, Job, Placement, Task, Form). Use it first when the agent has no context.YesOnboarded™ Admin, HR Representative, Integration, or Agentforce Access
Get Onboarded™ Field Mappings for ObjectReturns the field-level mappings for one object relationship, so the agent knows what a sync will read or write.YesSame as above
Onboarded™ Data SyncSyncs an existing, mapped Salesforce record to Onboarded™ (Create, Update, or Delete) using your field mappings. For Delete, pass the Onboarded™ ID.NoRuns as the calling user
Invoke Onboarded™ APISends a custom payload to the Onboarded™ API for data that doesn't match a single mapped record.NoRuns as the calling user
Get Onboarded™ Task Unlock SectionsIntended for Agentforce agents only. Lists the form sections of a completed task that can be unlocked so the employee can revise them. It reports eligibility only; it does not perform the unlock.YesOnboarded™ Agentforce Access, and the user cannot be on the Salesforce Integration User license

Suggested order for an agent

Call Get Onboarded™ Object Mappings to see what's configured, then Get Onboarded™ Field Mappings for Object for the object it cares about, then Onboarded™ Data Sync (for a mapped record) or Invoke Onboarded™ API (for anything else).

Good to know

  • A success result from the sync actions means the request was accepted and queued or sent, not that Onboarded™ has applied it yet. Agents should say "submitted for sync."
  • Access is checked per action, not for Agentforce as a whole. Data Sync and Invoke Onboarded™ API are not gated by an Agentforce check; the mapping lookup actions and Get Task Unlock Sections are (see the table above).
  • Assign Onboarded™ Agentforce Access to the user the agent runs as. See the Permission Sets page.
  • Full parameter tables and examples are on the Flow and Agentforce Integration page.