| Info | ||
|---|---|---|
| ||
Please note that this documentation and the links refer to the api v6. For more information please see the migration guide and the documentation related to v5. |
...
Please see the next sample authorization (Bearer token):
| Key | Value |
|---|---|
| "Authorization" | e.g. "Bearer asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
Please see the next sample authorization (api token):
| Key | Value |
|---|---|
| "ApiToken" | "asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
...
These events are fired by the Workstep Controller (internal component) and are fired before the data in eSAW is complete updated (some post-processing is required). Therefore this event callbacks are used only in rare integrations. For more information please see https://demo.esignanywhere.net/Api/swagger/ui/index#!/Envelope/Envelope_Send section EnvelopeSendActionCallbackSelection
Available Event Types
| Type | Description | ||
|---|---|---|---|
| ConfirmTransactionCode | A transaction code was sent | DefaultEventType | Not specially defined event type |
| AgreementAccepted | The user accepted the agreement | ||
| AgreementRejected AgreementRejected | The user rejected the agreement | ||
| RequestPrepareAuthenticationInformationSuccess PrepareAuthenticationSuccess | The request for additional authentication infos was requested | ||
| PrepareAuthenticationSuccess | The prepare authentication process succeeded | ||
| AuthenticationFailed | The prepare authentication process succeeded | ||
| AuthenticationFailed | The user failed to authenticate | ||
| AuthenticationRejected | The user rejected the authentication process | ||
| AuthenticationSuccess AuthenticationSuccess | The user succeeded to authenticate | ||
| ReAuthenticationFailed | The reauthentication process failed | ||
| AuditTrailRequested AuditTrailRequested | The audittrail was requested | ||
| AuditTrailXmlRequested AuditTrailXmlRequested | The audittrail XML was requested | ||
| CalledPage CalledPage | The viewer site was requested | ||
| WhoIsInformation | WHOIS information has been requested. | ||
| DocumentDownloaded DocumentDownloaded | The document download was requested | ||
| FlattenedDocumentDownloaded FlattenedDocumentDownloaded | The flattened document download was requested | ||
| AddedAnnotation AddedAnnotation | An annotation was added | ||
| AddedAttachment AddedAttachment | An attachment was added | ||
| AppendedDocument AppendedDocument | A document was appended | ||
| FormsFilled FormsFilled | A form field was filled | ||
| ConfirmReading ConfirmReading | A reading task was completed | ||
| PageViewChanged | PageViewChanged | Note: This event is only used for the audit trail, no notification is sent to the configured URL. The user changed the page view (e.g. by scrolling through the document). Note: This event is used for the audit trail, but not sent to the configured notification URL. | |
| SendTransactionCode SendTransactionCode | This event is raised, when a TransactionCode for a signature with type TransactionCode* has been sent using the IdentityServer or the TransactionCodeSenderPlugin | ||
| PushTransactionCode PrepareSignWorkstepDocument | This event is raised, when a TransactionCode for a signature with type TransactionCode has been sent using the TransactionCodePushPlugin | ||
| GetPushResult | This event is raised, when the result of the push plugin method GetPushResult returns a successful authentication | ||
| GetGenericSigningPluginAuthenticationStatus | This event is raised, when the result of the GenericSigningPlugin method GetAuthenticationStatus returns a successful authentication | ||
| PrepareSignWorkstepDocument | A signature is prepared for signing | ||
| PrepareSignPkcs7WorkstepDocument | A signature is prepared for P7M (PKCS7) signing. | ||
| FinalizeSignPkcs7WorkstepDocument | A signature is prepared for P7M (PKCS7) signing. | ||
| SignWorkstepDocument | Try to sign a signature | ||
| UndoAction | An action was undone | ||
| WorkstepCreated | A workstep was created | ||
| WorkstepFinished | A workstep was finished | ||
| WorkstepFinishedStarted | A workstep started to finish. | ||
| WorkstepRejected | A workstep was rejected | ||
| DisablePolicyAndValidityChecks | A signature is prepared for signing | ||
| SignWorkstepDocument | Try to sign a signature | ||
| UndoAction | An action was undone | ||
| WorkstepCreated | A workstep was created | ||
| WorkstepFinished | A workstep was finished | ||
| WorkstepRejected | A workstep was rejected | ||
| DisablePolicyAndValidityChecks | The policy and validity checks have been disabled. | ||
| EnablePolicyAndValidityChecks EnablePolicyAndValidityChecks | The policy and validity checks have been enabled. | ||
| FinalizeActionAutomaticSignature | A finalize action with an automatic signature was applied | ||
| FinalizeActionTimeStamp | A finalize action with a time stamp was applied | ||
| FinalizeLockForms | A finalize action with all forms getting locked | ||
| AppendFileToWorkstep | A AppendFileToWorkstep | A file was appended to the workstep | |
| AppendTasksToWorkstep AppendTasksToWorkstep | A task was added to the workstep | ||
| SetOptionalDocumentState SetOptionalDocumentState | A optional document became either active or inactive | ||
| StartBatch | A batch signing process started (not used anymore) | ||
| EndBatch | A batch signing process ended (not used anymore) | ||
| WorkstepExpired | A workstep was set to expired. | ||
| PreparePayloadForBatch | PreparePayloadForBatch | The payload is getting prepared for batch signing | |
| PreparePayloadForMultipleWorksteps | The payload is getting prepared for multiple worksteps. | ||
| ApplyPayloadForMultipleWorksteps | The payload is used while signing for multiple worksteps. | ||
| ExtendPayloadForBatch | The payload is getting extended for batch signing. | ||
| ExtendPayloadForMultipleWorksteps | The payload is getting extended for multiple worksteps. | ||
| StartExternalSigningProcess | Starting a signing process via an external service | ||
| FinishExternalSigningProcess | Finishing a signing process via an external service | ||
| PrepareGenericSigningPlugin | Prepares to sign a signature via an Generic Signing Plugin | ||
| SignGenericSigningPlugin | Signs a signature via an Generic Signing Plugin | ||
| ExternalAuthentication | External authentication succeeded | ||
| LogClientSettings | Used to log client-side settings like viewer preferences in the audit trail |
Draft Callbacks
Draft callbacks are fired, if a draft is used or deleted. The draft callback is set in the “CreateDraftOptions” (“AfterSendCallbackUrl”: “”), via the following call: https://demo.esignanywhere.net/Api/v6/envelope/create
...