notify_signers

Notification mail, when a signature request is created for users who have signatures in the document.

If a signatureOrder is defined and the creator has signatures in the document and is not on position 1, he will receive the email when it’s his turn.

observer

Pendant to the nofity_signers mail for an observer.

signature_request_failed

Notification mail, when a signature request failed.

If a signatureOrder is defined, a user only receives a signature_request_failed email, when he is on or below the active signatureOrder position.

signature_request_upcoming_due

Reminder mail sent three days before the due date of a signature request.

If a signatureOrder is defined, a user only receives a signature_request_upcoming_due mail, when he is on or below the active signatureOrder position.

user_finished

Notification that a user has signed/rejected all his signature fields in a document.

If the config mail_sent_to_registered_users is true, also registered users who are not creators receive the notification.

signature_request_finished

This email i sent when a document is finished.

If the document is part of an envelope, no notification for single documents are sent, but an signature_request_envelope_completed mail is sent when all documents in the envelope are completed (see below).

notify_signers_envelope

If a signatureOrder is defined and the creator has signatures in the document and is not on position 1, he will receive the email when it’s his turn.

If an envelope is created via tyrservice, no notify_signers mails for the individual documents are sent.

observer_envelope

Pendant to notify_signers_envelope mail for an observer.

If the envelope was created via tyrservice, no document observer mail (“observer”) will be sent for the documents of the envelope.

observer_envelope_completed

Pendant to signature_request_envelope_completed for an observer.

signature_request_envelop_upcoming_due

Reminder mail sent three days before the due date of the signature requests in an envelope.

If a signatureOrder is defined, a user only receives a signature_request_envelop_upcoming_due email, when he is on or below the active signatureOrder position.

signature_request_envelope_completed

Sent when all signature requests in an envelope are completed (failed or finished)

signature_field_signed

Notification mail, when a user rejects or signs a signature field.

If the config mail_sent_to_registered_users is true, also registered users who are not creators receive the notification.

Also sent for each signature fields of envelopes.

signature_field_rejected

• email

• id

• encryptedId

registered and active user:

• firstname

• lastname

• login

• company (optional)

guestuser associated with a document

• guestname

please note: Unregistered users which are added as a signer to a signature request via tyrservice.processXml neither have a firstname/lastname nor a guestname. Only a generic greeting can be generated.

• id

• encryptedId

• url (url for registered user leading to the login page forwarding to the document; optional)

• urlGuest (timeLimitedViewer)

• comment (optional)

• name (name of the envelope/document)

• guestAvailabilityDate (date till the urlGuest is valid. The availability is set with the server config guest_user_document_availibility. Default: 90 days. If a due date is defined, the link is valid till the due day plus the guest_user_document_availability. If not, the link is valid till the creation date plus the guest_user_document_availability)

• guestAvailabilityDays (days till the urlGuest expires.)

• created (creation date of the document/envelope)

• authorized: Boolean value (1/0), which defines, if the user is authorized to view the document. If the value is false, the user can’t access the document/envelope with the URLs. This maybe the case, if a user deletes a document.)

only if due is defined for envelope/document:

• dueDate (the date when the signature request expires)

• dueDays (days till the expiration date)

only for envelope:

• documents: List of all the documents contained in the envelope. Each document contains the information above. The List must be iterated https://freemarker.apache.org/docs/ref_directive_list.html ) e.g. <#list envelope.documents as document> <p>${document.name}: ${document.url}</#list>

notify_signers

A notify_signers email is sent, when a signature request is created or when the tyrservice method resendNotifySigner is called. In that case signatureOrder will be ignored and the email will be sent even if it is excluded.

Information:

• sender: creator of document

• receiver: signer of document

• document

sent to:

• w/o signature order: all users with signatures in document except the creator

• with signature order: all users (including the document creator) receive the email when they are on the active signature order position.

please note: If an envelope is created via the UI, all users receive notify_signers emails and a notify_signers_envelope email. If an envelope is created via tyrservice, only notify_signers_envelope emails are sent.

please note: If the signature request was created via UI and a guest signer was invited, no notify_signers email will be send for that user. An invitation mail with a link to the registration page will be sent. The user can just sign the document, if he registers for websignatureoffice.

observer

Notification mail for an observer of a document. The observer can be set in UI signatureRequest creation or via tyrservice.

Information:

• sender: creator of document

• receiver: observer of document

• document

sent to:

• all user which are document observers

please note: If an envelope is created via the UI, all observer receive observer emails and a observer_envelope email. If an envelope is created via tyrservice, only observer emails are sent.

signature_request_failed

A signature_request_failed message is send to all users of a document if it failed because mandatory fields were rejected, the request was stopped or the due date passed.

Information:

• receiver

• document

• reason: rejected/stopped/overdue

• statusId

• statusDetailedId

sent to:

• all signatories: depending on signatureOrder

• all observer

• the creator

signature_request_finished

A signature_request_finished mail is when the signature request of a document is finished.

Information:

• receiver

• document

sent to:

• all signatories: depending on signatureorder

• observer

• creator

signature_request_upcoming_due

A signature_request_upcoming_due mail is send three days before the due date passes.

Information:

• receiver

• document

sent to:

• all signatories

• creator

user_finished

A user_finished mail is sent, if a user finished all signatures in the document

Information:

• receiver

• sender: the user who finished his/her request

• document

sent to:

• creator of the document

signature_field_signed

A signature_field_signed email is send to registered users if another user signed a signaturefield

Information:

• sender: signer of the signaturefield

• receiver

• document

sent to:

• the creator of the document

please note: This email is sent for every signed signature field and may lead to allot of emails. It is advised to deactivate it. See Server configuration below.

signature_field_rejected

A signature_field_rejected email is sent to registered users if another user rejects a signature field in the document

Information:

• sender: the user who rejected the field

• receiver

• document

• reason: optional reason which the rejecting user can enter

• mandatory: 1/0 information if the signaturefield is mandatory or optional

sent to:

• the creator

notify_signers_envelope

A notify_signers_envelope mail is sent when an envelope is created or when the tyrservice method resendNotifySignerEnvelope is called. In that case signatureOrder will be ignored and the email will be sent even if it is excluded.

Information:

• sender: the creator of the envelope

• receiver: the users who have signatures in one or more documents of the envelope

• envelope

sent to:

• w/o signature order: all signers except the creator

• with signature order: all signers including the creator when they are on the active signature order position

please note: If an envelope is created via the UI, all users receive notify_signers emails and a notify_signers_envelope email. If an envelope is created via tyrservice, only notify_signers_envelope emails are sent.

observer_envelope

An observer_envelope mail is sent when an envelope is created.

Information:

• sender: the creator of the envelope

• receiver: the observer of the envelope

• envelope

sent to:

• all envelope observer

please note: If an envelope is created via the UI, all observer receive observer emails and a observer_envelope email. If an envelope is created via tyrservice, only observer emails are sent.

signature_request_envelop_upcoming_due

A signature_request_envelope_upcoming_due email is sent when one signature request of the envelope is due in three days.

Information:

• receiver: signer of the envelope

• envelope

sent to:

• all envelope users (even if they already signed)

signature_request_envelope_completed

A signature_request_envelope_completed email is sent, when all signature requests of an envelope are either failed or finished.

Information:

• receiver

• envelope

sent to:

• creator

• signatories

observer_envelope_completed

A observer_envelope_completed email is sent, when all signature requests of an envelope are either failed or finished.

Information:

• receiver

• envelope

sent to:

• observer

invitation

An invitation mail is sent to a non registered user, when a registered user invites. This can be done when creating a signature request or by inviting the user as a contact.

Information:

• sender: The inviting user / signature request creator

• receiver: The invited user

• document (optional)

• invitationUrl: Link to the registration page

• message: message entered by inviting user

sent to:

• specified invited user

Please note: If the invitation is sent with a signature request no notify_signers mail will be sent to the user. The document information are contained in the invitation mail.

invitation_accepted

An invitation accepted mail is sent when a user accepts an invitation which was sent by another user.

Information:

• receiver: The user who invited

• sender: The user who accepted the invitation

sent to:

• the user who invited

friend

A friend mail is sent, when a user requests another registered user as a contact.

Information:

• receiver

• sender

• url: The Url to accept the friend request

sent to:

• user who was requested as friend

friend_accepted

A friend_accepted email is sent when a registered user accepts a friend request

Information:

• receiver: The user who requested the user user

• sender: The user who accepted the friend request

sent to:

• the user who sent the friend request

email_validation

An email validation mail is sent when a user registers at websignatureoffice. The user has to confirm the email adress by clicking the verification link and entering the token.

Information:

• receiver

• token: One time token to confirm the email change

• verificationUrl: The url to enter the token

• verificationUrlWithToken: Confirmation link with token attached

sent to:

• user who started the validation process