Enterprise Customers: Separate fees are required for access to Malbek Klix. Contact your Malbek representative for details.
Now that you've created your Malbek Klix agreement, options for sharing include emails, hyperlinks, or embedding code onto your website with the optional use of parameters. This article covers:
- What are Parameters?
- Use Cases
- Adding Notification on Signature Parameters
- Adding Pre-Filled Signer Data
- Summary of Parameter Options
What are Parameters?
You can pass information from your Klix Agreement into parameters, as shown in the example below.
- Field Name represents fields selected on a Klix Template (including custom fields)
- Parameters that start with system are standard Malbek fields.
Example Parameters:
{
'Field Name' : 'Field Value',
'system.notifyOnSign': [],
'system.notifyCCOnSign': [],
'system.notifyBCCOnSign': []
}
Use Cases
Notify on Signature
Perhaps you would like to set up notifications to notify users upon signature. Depending on how the recipient should be added to the email, notifications can be set up in the To, CC, or BCC columns.
Pre-Filling Signer Data
Following a similar format, you can have data pre-filled for signers. Simply swap out 'system.notifyOnSign' with the exact Field name. Let's say there is a "Company" Field on your Clickwrap Template, and this particular embed code will only be used for signers from the same company "Acme." This can be done for existing Fields or those you have custom-created in Malbek Klix. If desired, this can also pull from external sources.
Adding Notification on Signature Parameters
Locate the spot in your existing embed code called params: that was copied when sharing via embed code:
Using the example code shown below, insert emails into the space {between the brackets} after params: with apostrophes around the beginning and end of your email address.
'system.notifyOnSign': [],
'system.notifyCCOnSign': [],
'system.notifyBCCOnSign': []
Alternatively, you can insert just the emails without brackets, but be sure to have apostrophes around the beginning and end of your email address.
Tip: If using multiple system notifications, separate each with a comma.
Adding Pre-Filled Signer Data
Locate the spot in your existing embed code called params: that was copied when sharing via embed code:
From Malbek Klix
Using the example code shown below, insert emails into the {between the brackets} after params: with apostrophes around the beginning and end of your Field Name(s) and Field Value(s).
'Field Name' : 'Field Value',
'Field Name' : 'Field Value',
'Field Name' : 'Field Value'
Note: If the Field Name is more than one word, remove the space for this to work properly (e.g., 'CompanyName' instead of 'Company Name'). Spaces can remain in the Field Values.
Alternatively, you can insert just the Field Name(s) and Field Value(s) without brackets, but be sure to have apostrophes around the beginning and end of your Field Name(s) and Field Values.
Tip: If using multiple system notifications, separate each with a comma.
If you'd like to prevent signers from editing or even viewing this pre-filled data, refer to Creating Your Malbek Klix Template for details on editing the Fields and marking them as Read Only and/or Hidden.
From Other Sources
Writing your own script here is also supported, allowing for the correct values to be pulled in dynamically from some other source. This is ideal, for instance, if you want to embed your agreement within a third-party portal where signers will be logging in (e.g., SSO). Your script could pull the signer's name, email, etc. from their user account for the portal. Refer to that specific external source for guidance on formatting these fields and values into your Klix Agreement.
Summary of Parameter Options
Need a quick refresher?
Parameter Type |
Format Example |
---|---|
Notifying on Signature |
params: {'system.notifyOnSign': ['abc@mail.com'], |
Notifying on Signature (without brackets) |
params: {'system.notifyOnSign': 'abc@mail.com', |
Pre-Filling Signer Data |
params: {'CompanyName':'Malbek', |
Pre-Filling Signer Data (without brackets) |
params: {'CompanyName':['Malbek'], |