ESignature
Allows integrating electronic signature (eSign) capabilities into your workflows. User inputs provided in the product's GUI—such as document, sign provider details, subject, and body—serve as the triggering inputs. After these inputs are submitted, the workflow automatically invokes the appropriate eSign API to complete the process.
- Group: Business Interactions
- Nature: Blocking
ESignature Runtime API details
On the product side, the ESignature runtime API provides the status of the workflow activity, including actions like "Send for Signature" or "Override." The product uses this information to display a "Send for Signature" button, which allows users to submit the document for electronic signature. Once the specific entry criteria are met and the workflow is in a suspended state, the system uses below APIs to submit the eSignature request for the context record.
API endpoints
Standalone Workflow: POST /api/workflow/v1/runtime/workflow-instances/{workflowInstanceId}/activities/{activityId}/esign
Staged Workflow: POST /api/workflow/v1/runtime/stage-instances/{stageInstanceId}/activities/{activityId}/esign
Sample request payload
Standalone Workflow:
{
"workflowInstanceId": "74c83333-f7d9-4e96-aa27-3c4c3581a2e4",
"ActivityId": "5010c7bc-bf0f-4605-9c56-2299a683440a",
"ESignModel": "Model Data"
}
Staged Workflow:
{
"StageInstanceId": "74c83333-f7d9-4e96-aa27-3c4c3581a2e4",
"ActivityId": "5010c7bc-bf0f-4605-9c56-2299a683440a",
"ESignModel": "Model Data"
}
Example:
In a contract approval process, after a contract is reviewed and finalized, the workflow needs to send the contract to the relevant parties for an electronic signature using an eSign provider like DocuSign. The eSignature activity will automate this process. Once these conditions are met, the workflow triggers the eSignature activity, and the contract is sent for signing.
Properties and activity information
Properties determines the initial behavior of the activity.
Field |
Description |
---|---|
Details | |
Display Name | Enter the name of the activity. |
Reference Name | Enter the technical name of the activity. If left blank, the system automatically generates it based on the value in the Display Name field. The generated name removes special characters, eliminates spaces, avoids consecutive underscores, and joins words with a single underscore. |
Description | Provide a description that is relevant to the activity. |
Properties | |
Entry Criteria |
Set the conditions that must be met to trigger the workflow.
To add more conditions, click Add Criteria. To remove all conditions, click Remove All. |
Switch to New Entry Criteria | You will see this toggle only when editing an activity in an existing workflow. Enabling this toggle upgrades the activity to the new IntelliSense Criteria Builder and migrates the old criteria. If the migration fails, you must correct the criteria for a successful conversion or continue using the older version indefinitely. Once switched, you cannot revert to the older Criteria Builder. |
Filter Expression |
By default, the application applies AND logic to all criteria. You can adjust this to create more complex logical expressions if needed. You can customize your logic using parentheses, AND, OR, and NOT. For example, if you enter “(1 AND 2 AND 3) OR 4”, the system will evaluate whether all three of the first conditions are true, or if the fourth condition is true. |