Skip to content

Agent screen pops

Markdown

The cards a human agent sees when a conversation arrives.

Assign screen pops · Changes data · can overwrite or remove · Reached with dakso_explore

Assigns published screen pops: org_default = id of the organization’s default (“” to remove it); queues = {queueName: screenPopId, or null to remove}. With no arguments it only reads the current assignment ({orgDefault, queues}). Assigning requires the admin role. A queue’s screen pop wins over the default; the flow can request another with screenPopId.

Argument Type Required Description
descripcion string No One short sentence: what this call changes and why (10-200 chars, no personal data).
org_default string No
queues object No

Delete a screen pop · Changes data · can overwrite or remove · Reached with dakso_explore

Deletes a screen pop and all its versions. Destructive action. If it is assigned, unassign it first with screenpop_assign. For safety the agent does not run this action: the tool returns a link to the Dakso admin screen where a person confirms it. Give the user that link.

Argument Type Required Description
screen_pop_id string Yes
descripcion string No One short sentence: what this call changes and why (10-200 chars, no personal data).

Get an agent screen pop · Read only · Reached with dakso_explore

Reads a screen pop: header, draft, published definition, list of versions and assignedTo. With version it returns that frozen version. The definition uses ctx.* (the flow’s agentContext) and its data catalog declares the fields it expects.

Argument Type Required Description
screen_pop_id string Yes
version integer No

List agent screen pops · Read only · Reached with dakso_explore

Lists the organization’s screen pops (the card an agent sees when taking a conversation): id, name, published version and where each is assigned (organization default or queues). Use it first to see what exists before reading, editing or assigning one.

No arguments.

Publish a screen pop · Changes data · can overwrite or remove · Reached with dakso_explore

Publishes the draft of a screen pop as version N+1; agents see it at once wherever it is assigned. Review it first with screenpop_validate and screenpop_render using sample data, and confirm with the user.

Argument Type Required Description
screen_pop_id string Yes
descripcion string No One short sentence: what this call changes and why (10-200 chars, no personal data).
notes string No Default: "".

Preview a screen pop · Read only · Reached with dakso_explore

Preview: resolves a screen pop definition with sample data and returns what the agent would see ({sections, toast, errors}). data = {“ctx”: {…}, “item”: {…}, “contact”: {…}, “agent”: {…}}; ctx is the agentContext the flow would send (the example values of the definition.data catalog work as samples).

Argument Type Required Description
data object Yes
definition object Yes

Save a screen pop draft · Changes data · can overwrite or remove · Reached with dakso_explore

Saves the draft of a screen pop; if it does not exist it is created with that id (^[a-z][a-z0-9_]{0,47}$). definition = ScreenPopDefinition (schemaVersion 1: toast, sections with widgets, actions, data). It is fed by ctx.*, the agentContext the flow sends on handoff: declare expected fields in definition.data (key = agentContext key) and send the same keys from the flow. It does not publish (use screenpop_publish). If the definition is invalid it returns saved=false with an errors list.

Argument Type Required Description
definition object Yes
screen_pop_id string Yes
descripcion string No One short sentence: what this call changes and why (10-200 chars, no personal data).
description string No
name string No

Validate a screen pop definition · Read only · Reached with dakso_explore

Validates a screen pop definition without saving it: returns {valid, errors}. Templates read ${ctx.<key>} from the agentContext the flow sends, and definition.data is the catalog of those fields (key, label, type, example). Use it before screenpop_save_draft.

Argument Type Required Description
definition object Yes