---
schema_version: "1"
id: 1c611d5ed5d8433a16fb1f5ed5e79c0ebe46f8c11e761a7a4ff1ef4da1558671
title: Sales Engagement Methods for Lightning Experience
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/service-cloud/api-cti/guides/sforce-api-cti-hvs-lex.md
canonical_url: https://developer.salesforce.com/docs/service/api-cti/guide/sforce-api-cti-hvs-lex.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 24518f1e588b75343735e2d41a534b2f5b4a93d3daeb2c022d705c8ad8dc1a0e
products:
  - Open CTI Developer Guide
  - Service Cloud Developer Content
---

# Sales Engagement Methods for Lightning Experience

## Usage

These two methods allow your CTI implementation to communicate with [Sales Engagement](https://help.salesforce.com/articleView?id=high_velocity_sales.htm) to handle Sales Engagement work. The `onWorkStart` method lets you listen for when a Sales Engagement work item starts. You communicate back to Sales Engagement with the `completeWork` method when the work completes. These methods are available in API version 46.0 or later.

**note:** You can use this method with the Lightning web component `lightning-click-to-dial`. You can also use it with the Aura component `lightning:clickToDial`. Keep in mind that you can’t use either component in iFrames. This method can’t be used with the Visualforce component `support:clickToDial`.

**note:** `CallEnd` is deprecated as of API version 48.0.

## Syntax

The `onWorkStart` method lets you listen for when work starts. Sales Engagement calls your listener function when the work starts. In your listener, the `completeWorkWhen` parameter specifies whether to call Sales Engagement back when the task is saved (`TaskSaved`).

```javascript
sforce.opencti.hvs.onWorkStart({listener: FUNCTION});

{ // Listener function payload
  workId: STRING,            // Id of the current work
  completeWorkWhen: STRING,  // 'TaskSaved'
  attributes: {
    to: STRING               // Used to match to click_to_call
  }
}
```

When the work completes (when the task is saved), call the `completeWork` method so that the Sales Engagement system can update its information.

```javascript
sforce.opencti.hvs.completeWork({
  workId: STRING,          // Id from onWorkStart 
  attributes: {
    disposition: STRING,   // Only needed for task
    taskId: STRING,
    wasConnected: BOOLEAN, // Should be added, otherwise defaults to true
  },
  callback: FUNCTION
});
```

**note:** Only call this method for outbound calls. Inbound calls aren't started by Sales Engagement.

## Arguments

Arguments for `onWorkStart`:

|Name|Type|Description|
|------|------|-------------|
|`listener`|function|Function that is called when the work is started. This function’s payload includes `workId`, `completeWorkWhen`, `attributes`, and `to`.|
|`workId`|string|ID of the work item. Depending on the type of work, this value is either the step tracker ID or the my list ID.|
|`completeWorkWhen`|string|Defines when to call the `completeWork` method. This value is `TaskSaved`.|
|`attributes`|object|Attributes object that contains the `to` field.|
|`to`|string|This field is used to link to the number in `onClickToDial`.|


Arguments for `completeWork`:

|Name|Type|Description|
|------|------|-------------|
|`workId`|string|ID of the work item. Use the same value that you previously received in `onWorkStart`.|
|`attributes`|object|Attributes object that can contain the following fields: `disposition`, `taskId`, `wasConnected`.|
|`disposition`|string|Value of the disposition. Required when `completeWorkWhen` is `TaskSaved`.|
|`taskId`|string|ID of the task. Required when `completeWorkWhen` is `TaskSaved`.|
|`wasConnected`|boolean|Indicates whether the call successfully connected. We recommend always passing this value. If not passed, the value defaults to true.|
|`callback`|function|Function executed when the call completes.|


## Sample Code

Listen for Sales Engagement work to start:

```javascript
sforce.opencti.hvs.onWorkStart({
    listener: function(payload) {
        var workId = payload.workId;             // Save the work ID
        var whenVal = payload.completeWorkWhen;  // Save the completion requirement
        var toVal = payload.attributes.to;       // Save the number to associate with onClickToDial
    }
});
```

Call Sales Engagement when a task is saved:

```javascript
sforce.opencti.hvs.completeWork({
  workId: a07B0000006VFHrIAO,      // Id sent via onWorkStart
  attributes: {
      disposition: 'Completed',    // Disposition value
      taskId: '00TR00000032yfVMAQ' // ID of task created
      wasConnected: true           // Whether the call successfully connected
  },
  callback: function() { /* perform cleanup here */ }
});
```