Invocable Method

Prev

Lightico for Salesforce supports the following invocable actions:

Note:

All actions are Global class.

Create a new session with an eSign template

Action Name: CreateSingleSession

Creates a new Lightico session that can include a preconfigured eSign document.

Input parameters

Input class name: CreateSingleSessionWrapper

Parameter Type Description
recordId string ID # of Salesforce record from which the session is originating
customerName string Name of customer that is used in the session
Note: You must include customerPhoneNumber and/or   customerEmail.
customerPhoneNumber string Customer's phone number for sending the SMS session invitation
customerEmail string Customer's email address for sending the session invitation
userName string Lightico username of the agent associated with this session
lookUpField string Name of the field that links the session object with another object
esignTemplateId string Identifies the document template. This ID # is found at the top left when the document template is opened in the PDF editor.
teamId integer Identifies the team from which the session is running. This number appears in the Administration UI - log in to Lightico and go to Settings > Teams.
chatActive boolean true = customer chat enabled, false = customer chat disabled - customer cannot send text message to agent
userId string Identifies the Salesforce agent associated with this session
sendNow boolean true = send a session invitation to the client upon creation of the session, false = do not send invitation
hubName string Name of the Lightico document storage integration hub - the final document will be saved here

Response

Response class name: CreateSingleSessionResponse

Parameter Type Description
sessionId string Identifies a Lightico session
customerURL string Opens the customer collaboration UI

Create a new session with an ad hoc eSign

Action name: CreateSessionWithEsign

  • Creates a new session that can include an ad hoc eSign document.
  • The parameters in this action use tags to postition signature, initials and signature date fields in the final PDF.

Input parameters

Input class name: CreateSessionWithEsignWrapper

Parameter Type Description
userName string Lightico username of the agent associated with this session
lookUpField string Name of the field that links the session object with another object
signatureTag string Identifies the signature field position
initialsTag string Identifies the initials field position
signatureDateTag string Identifies the signature date field position
fileName string Name that you give to the eSign for this session. This is the name that will appear in the customer UI instead of the file name of the eSign.
role string Defines the role of the customer: signer = provides a signature, approver = approves by clicking a button
recordId string Identifies the record from which the session will originate.
chatActive boolean true = customer chat enabled, false = customer chat disabled - customer cannot send text message to agent
customerName string Name of customer that is used in the session
sessionId string Create an ID for this session instead of the default sessionId created by Lightico
saveInAttachments boolean Save assets from this session in a generic object called "Attachments" instead of saving the assets in the Lightico files object
Note: You must include customerPhoneNumber and/or   customerEmail.
customerPhoneNumber string Customer's phone number for sending the SMS session invitation
customerEmail string Customer's email address for sending the session invitation
sendNow boolean true = send a session invitation to the client upon creation of the session, false = do not send invitation
documentId string Identifies a Salesforce document that you are adding to the session
hubName string, optonal Name of the Lightico document storage integration hub - the final document will be saved here

Response

Response class name: CreateSessionWithEsignResponse

Parameter Type Description
sessionId string Identifies a Lightico session
customerURL string Opens the customer collaboration UI
esignId string Identifies a specific eSign document within a session
runTime integer Time in took for this action to be implemented in miliseconds

Add an eSign template to a session

Action name: AddEsignToSession

Add a preconfigured eSign template to an existing session.

Input parameters

Input class name: AddEsignToSessionWrapper

Parameter Type Description
sessionId string Identifies an existing session
esignTemplateId string Identifies the document template. This ID # is found at the top left when the document template is opened in the PDF editor.

Response

Response class name: AddEsignToSessionResponse

Parameter Type Description
esignId string Identifies a specific eSign document within a session
statusCode integer Response code, e.g. 200, 400
responseBody string Response message, e.g. OK, Error

Add an ad hoc esign to a session

Action name: AddEsign

  • Add an ad hoc eSign to an existing session.
  • The parameters in this action use tags to postition signature, initials and signature date fields in the final PDF.

Input parameters

Input class name: AddEsignWrapper

Parameter Type Description
documentId string Identifies a Salesforce document that you are adding to the session
sessionId string Identifies an existing session
signatureTag string Identifies the signature field position
initialsTag string Identifies the initials field position
signatureDateTag string Identifies the signature date field position
fileName string Name that you give to the eSign for this session. This is the name that will appear in the customer UI instead of the file name of the eSign.
role string Defines the role of the customer: signer = provides a signature, approver = approves by clicking a button

Response

Response class name: AddEsignResponse

Parameter Type Description
esignId string Identifies a specific eSign document within a session

Add a text message to a session

Action name: AddTextMessage

Send a text message to the customer UI in a session.
The text appears in the chat field of the collaboration UI.

Input parameters

Input class name: AddTextMessageWrapper

Parameter Type Description
sessionId string Identifies the session to which you are adding this action
textMessage string Text of the message you are sending. Example: Do you need help reviewing the document?

Response

Response class name: AddTextMessageResponse
Type: Boolean
Description: true= message sent, false= message was not sent

Generate a document from a Lightico template

Action Name: GenerateDocumentByTemplate

Generates a PDF document based on a Lightico template and attributes mapped to Salesforce.

Input parameters

Input class name: DocumentGenerationData

Parameter Type Description
recordId string ID # of Salesforce record from which to draw the attributes. In addition, the generated PDF is saved in the Notes and Attachments section of the record.
templateId string Identifies the document template. This ID # is found at the top left when the document template is opened in the PDF editor.
hubName string, optonal Custom hub name for filtering events

Response

Type: Boolean
Description: true= success, false= failure

Code example

Lightico_GlobalMethods lg = new Lightico_GlobalMethods();
Lightico_GlobalMethods.DocumentGenerationData data = new Lightico_GlobalMethods.DocumentGenerationData();
data.recordId = '0030b00002RounDAAR';
data.templateId = 'c8552241-f718-4ad7-8c58-e0b8323c35c3';
boolean res = lg.GenerateDocuemntByTemplate(data);
system.debug(res);