Managing Notifications and Share Links
By default, DottedSign API uses email for notifications. When a task is created or updated, both the task owner and the corresponding signers receive notification emails, which may include details such as a share link or a PDF file, depending on the type of notification.
If developers wish to customize the notification and signing process due to branding or corporate control considerations, they can implement the following customizations:
Disable Notification
When creating a task using either the Quick Create a Task API or the Create a Task API, notifications can be opted out of:
- To prevent the owner from receiving email notifications, set
task_setting.owner_informable
tofalse
. - To prevent the signer from receiving email notifications, set
stages[].stage_setting.informable
tofalse
.
Using Quick Create API as example.
{
"file_name": "My Task",
"template_id": 1,
"stages": [
{
"email": "[email protected]",
"name": "John",
"stage_setting": {
"informable": false
}
}
],
"task_setting": {
"owner_informable": false
}
}
Using Share Link
If email notifications are disabled, developers must provide the signing link to users themselves, possibly through Slack integration or other methods. The signing link for a specific task can be obtained via the Get the Share Link API.
Embedding Signing Page via iframe
The signing page can be embedded into any webpage using an iframe, making it accessible to all users. This integration allows for a seamless signing experience directly within your application or website.
Example:
<iframe src="<YOUR_SHARE_LINK>" width="600" height="400"></iframe>
Task Bundling with Redirect URL
In some cases, developers may want signers to be able to sign multiple tasks at once through a single share link, similar to bundling all required documents into one envelope. This functionality can be achieved by using the task_ids
and redirect_url
parameters in this API. The process is illustrated below:
{
{
"task_ids": [1,2,3],
"email": "[email protected]",
"redirect_url": "https://google.com"
}
}
Updated 5 days ago