Requirements¶
Lime Marketing application with a valid sending domain¶
All TRAML communication is sent via a Lime Marketing application.
The Lime Marketing application must have at least one valid sending domain to be able to send TRAML messages. Follow the instructions on the sending domain page in Lime Marketing and verify the domain with the deliverability toolbox
Active SMS Module for Sending SMS¶
When sending SMS messages the SMS module in Lime Marketing has to be activated.
Lime CRM¶
-
On-premise: Lime CRM Server: 2022.3.1015 (lime-crm 2.437) or later.
-
Cloud: Requires isolated application using lime-crm 2.437 or later. (It is available for Lime eSign in shared cloud)
On-premise requirements¶
limepkg-transactional-message-library communicates with the Lime Marketing API so make sure the Lime Server has access to Lime Marketing Cloud environment over https. (You should be able to open a browser and go to the Lime Marketing app on the Lime Server)
Using Custom Webhook Listener for TRAML events¶
If a custom webhook listener is used for traml events, the communication needs to be open both ways. 1. Make sure the Webclient is enabled. 2. The customer needs to set up a publicly available IP/hostname for us to use to connect to the on-premise Lime server. - The integration doesn't require a hostname - a IP address is enough. - The certificate for HTTPS does not have to been issued by a trusted CA but its recommended (self-signed certificates is supported).
- The customer IT needs to allow HTTPS traffic (port 443) from at least the newsletter environment through the firewall to the Lime server.
Source IP | Destination IP | Destination Port | Description |
---|---|---|---|
any or 84.19.149.64/27 | IP from step 2 | 443 | Rule to allow traffic via the publicly available IP to the Lime server from any or the Newsletter environment |
- Some on-premise solutions also have a reverse proxy solution in front of their servers which the IT need to configure as well to direct traffic through to the Lime Server.