Event handler in the Playbook intake component
A component triggers an event when a certain condition is met or on user interaction. The event can be used to execute an action through a code on a third-party webpage.
| Event handler | Description | Payload |
|---|---|---|
| SN_EMBEDX_PLAYBOOK_INTAKE #COMPONENT_READY | This event is dispatched when a component is ready and usable. | None |
| SN_EMBEDX_PLAYBOOK_INTAKE #COMPONENT_ERROR | This event is dispatched when a property validation or internal error occurs. | errorType, errorMessage |
| SN_EMBEDX_PLAYBOOK_INTAKE #RECORD_CREATION_SUCCEEDED | This event is dispatched when a record is created by a Record Generator Playbook. | table, sysId, number, playbook_experience_id, hide_record_creation |
| SN_EMBEDX_PLAYBOOK_INTAKE #PRIMARY_BUTTON_CLICKED | This event is dispatched when the primary button is selected the record created confirmation page. | table, record_sys_id, playbook_experience_id |
| SN_EMBEDX_PLAYBOOK_INTAKE #SECONDARY_BUTTON_CLICKED | This event is dispatched when the secondary button is selected on the record created confirmation page. | table, record_sys_id |
| Additional event handlers | ||
| SN_EMBEDX_PLAYBOOK_INTAKE #OPEN_LIST | This event is dispatched when an open list event is fired. | table, listTitle, query, disableInlineEditing, listView |
| SN_EMBEDX_PLAYBOOK_INTAKE #ACTIVITY_SELECTED | Select the provided playbook, stage, and activity by context ID. | playbookContextId, stageContextId, activityContextId |
| SN_EMBEDX_PLAYBOOK_INTAKE #ACTIVITY_STATE_CHANGED | This event is dispatched by Playbook Custom Layout Controller when playbook activity state has changed to either Complete, Skipped, canceled, or Error. | playbookContextId, stageContextId, activityContextId |
| SN_EMBEDX_PLAYBOOK_INTAKE #STAGE_SELECTED | Select the provided playbook and stage by context ID. | playbookContextId, stageContextId |
| SN_EMBEDX_PLAYBOOK_INTAKE #UPDATE_SELECTION | This event is dispatched by the Playbook Custom Layout Controller when the selected state of a playbook, stage, or activity has changed. | selectedPlaybook, selectedStage, selectedActivity |
| SN_EMBEDX_PLAYBOOK_INTAKE #FILTER_SELECTED | This event is dispatched when playbook filter is opened or closed. | playbookContextId, value |
| SN_EMBEDX_PLAYBOOK_INTAKE #USER_INTERACTION | This event is dispatched on User interaction with a Playbook Activity. | playbookContextId, parentTable, parentRecord, stageName, stageTitle, stageState, activityTitle, activityContextId, associatedTable, associatedRecord |
| SN_EMBEDX_PLAYBOOK_INTAKE #OPEN_RECORD | This event is dispatched when an open record event is fired. | table, sys_id, params, query |
| SN_EMBEDX_PLAYBOOK_INTAKE #FILTER_OPTION_SELECTED | This event is dispatched when an item is selected the playbook filter. | playbookContextId, item |
| SN_EMBEDX_PLAYBOOK_INTAKE #PLAYBOOK_EXPANDED | This event is dispatched when the playbook stage list changes expanded state. | playbookContextId, updatedExpandState |
Related topics
Configure the Playbook intake component instance
Embed the Playbook intake component instance on the third-party website