Versions Compared

Version Old Version 1 New Version 2
Changes made by

Manuel Gierlinger

Manuel Gierlinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Please see the following instructions and guides in order to configure and use the whatsapp notification channel successfully.

Table of Contents
stylenone

Preconditions

  • Defined templates for all the supported notification types on Meta profile.

  • Valid credentials for Namirial WhatsApp Gateway.

  • Valid FileHoster configuration in _globalXML

  • Enable WhatsApp feature flag in eSignAnyWhere (AllowWhatsAppNotification) and optionally allow WhatsApp for bulk if required by enabling (BulkEnvelopesWithWhatsAppNotifications).

Configuration

Global.xml

Code Block
<notificationPlugin customPluginId="whatsapp" isDefault="0">
			<enabled values="0;1">1</enabled>
			<assembly>COMPLETE_PATH_TO_namirial.Plugin.Notification.WhatsApp.dll</assembly>
			<type>namirial.Plugin.Notification.WhatsApp.WhatsApp</type>
			<pluginConfiguration>
				<NetworkConfiguration>
					<NamirialWhatsappGatewayBaseUrl>LINK_TO_NAMIRIAL_WHATSAPP_GATEWAY</NamirialWhatsappGatewayBaseUrl>
				</NetworkConfiguration>
				<LocalizationsDirectory>DIRECTORY_PATH_OF_XLIFF_FILES</LocalizationsDirectory>
			</pluginConfiguration>
</notificationPlugin>

NamirialWhatsappGatewayBaseUrl

URL to the Namirial WhatsApp Gateway. Note: Please enter only the “base URL” without “api/services”

Organization Settings

...

Username

The username for the WhatsApp Gateway

Password

The password for the WhatsApp Gateway

API Token

The API token for the WhatsApp Gateway

Notification templates mapping JSON

The JSON for the template mapping between eSAW’s Notification Types and Meta’s Template Ids.

WhatsApp notification contents/templates must be defined in Meta-WhatsApp admin panel and cannot be defined or modified in eSignAnyWhere directly. The declared notification templates defined on Meta’s side must be mapped to the notification types sent by eSignAnyWhere.

Example of the mapping JSON

Code Block
{
    "Templates": [{
            "NotificationType": "NOTIFICATION_TYPE_NAME",
            "WhatsAppTemplateId": "TEMPLATE_ID",
            "Params": []
        }, {
            "NotificationType": "NOTIFICATION_TYPE_NAME",
            "WhatsAppTemplateId": "TEMPLATE_ID",
            "Params": [
            "#PARAM1#"
            ]
        }, {
            "NotificationType": "NOTIFICATION_TYPE_NAME",
            "WhatsAppTemplateId": "TEMPLATE_ID",
            "Params": [
                "#PARAM1#",
                "#PARAM2#"
            ]
        }
    ]
}

NotificationType

Please find the available notification types for whatsapp channel in the table below:

Notification Type

Usage

Deleted Recipient

Notifies the recipient that the recipient has been removed from a signing task of an envelope

Disclaimer (Download Link)

Notifies the recipient and contains a link to download legally required information about issuance of the disposable certificate.

Envelope cancelled

Notifies the recipient about a cancelled envelope

Envelope deleted

Notifies the recipient about a deleted envelope

Envelope expired (recipient)

Notifies the recipient about an expired envelope

Envelope reset (parallel recipient)

Notifies the recipient who is currently working on an opened envelope, that the envelope was locked and the data reset by the envelope sender in a parallel scenario

Must view

Notifies the recipient about an envelope, which needs to be viewed

Ready for signing (parallel recipient)

Notifies the recipient that the previous signer has finished the envelope

Sign Reminder

The template is used only to define a prefix for the mail subject, when sending a reminder.
The body of the "Remind" template will not be used, as the standard mail body from the "Sign", "Sign (with dynamic app links)", "Sign delegated envelope" is used to send reminders to the recipient.

Sign Delegation Reminder

The template is used only to define a prefix for the mail subject, when sending a reminder.
The body of the "Remind" template will not be used, as the standard mail body from the "Sign", "Sign (with dynamic app links)", "Sign delegated envelope" is used to send reminders to the recipient.

Must View Reminder

The template is used only to define a prefix for the mail subject, when sending a reminder.
The body of the "Remind" template will not be used, as the standard mail body from the "Sign", "Sign (with dynamic app links)", "Sign delegated envelope" is used to send reminders to the recipient.

Send copy of finished envelope to CC recipient

Notifies the CC recipient about finished envelope and includes download link

Send copy of finished envelope to CC recipient (non-registered)

Notifies the non-registered CC recipient about finished envelope and includes download link

Sign

Sent to the recipient to invite him to sign a document.
Note that instead of Sign, the "Sign (with dynamic app links)" template is used as at least one of the envelope's API parameters Recipient.AddAndroidAppLink, Recipient.AddIosAppLink,Recipient.AddWindowsAppLink is true.

Sign delegated envelope

Notifies the recipient about delegation of an envelope for signing

Test notification

Test notification which notifies if the configuration for the notification channel is set up correctly

WhatsAppTemplateId

The Id of the template defined on Meta’s account to be used for a specific notification type.

Params

Ordered list of parameters to be replaced in the template’s body. Parameters should be added in the mapping JSON between two '#' marks similar to how they appear in eSignAnyWhere for other notification types. (e.g. #FirstName#).