HomeGuidesAPI
HomeGuidesRecipesAPI
HomeGuidesAPILog In

OneSpan Event

Suggest Edits

Overview

The OneSpan External State Extension allows data to be collected in a SmartIQ form/PDF document and sent to OneSpan for signatures. Once the signature process is complete, OneSpan sends the result to SmartIQ so the workflow can be continued or finalized. The process relies on Cloud to Cloud (C2I) integration between the two platforms.

Configuration

To receive the OneSpan response, SmartIQ exposes a WebHook specifically designed to receive authenticated and validated messages.

Configure Manage Settings

  1. In Manage, go to Settings > OneSpan.
  2. Specify a Callback Key. A relatively long string, similar to a guid.
  3. Save the Settings.

OneSpan Configuration

  1. Go to your OneSpan console and register for event notifications.
  2. Set the callback URL to your produce URL) + /webhooks/OneSpan. For example, <https://companyname.smartcommunications.cloud/produce/webhooks/OneSpan> .
  3. Set the callback key to the same value that was entered in Manage settings.
  4. Select event notifications to send to SmartIQ.

📘

Handled Events

Only the events listed will processed. Others will be logged (if debug mode is on) and ignored.

EventDisplay NameDescription
PACKAGE_COMPLETECompleteA package has completed the signing process.
If there are multiple signers then the "sessionUser": "...", will be the signer ID of the last signer to sign.
PACKAGE_TRASHTrashA package was moved to the trash folder in OneSpan Sign's Inbox (status = TRASH).
PACKAGE_DELETEDeleteA package has been deleted from the OneSpan Sign.com system.
PACKAGE_DECLINEDeclineA recipient has declined to sign a package, and has specified a reason for doing so, The Originating System can use that reason to determine the next step for the package.
PACKAGE_EXPIREExpireA package has exceeded its expiration date.
PACKAGE_OPT_OUTOpt_OutA recipient has opted out of signing a package.
PACKAGE_ARCHIVEArchiveA callback notification indicates that a package has been archived.

You can now add an External State Event to your workflow project and select the OneSpan state type.

Updated about 2 months ago