Skip to content

Installation Instructions

Preparations

Installation

Adding this addon to your solution is straight forward. Make sure you complete all the steps in every section below

1. Install package

Run poetry add limepkg-communication-flow in your solution folder.

If using the recommended Create a summarizing history note when sending and receiving emails also add the helper functions needed by running poetry add limepkg-base-solution-helpers

2. Install LIP-package

Install the Lip-package attached to the latest release

3. Create API User

We need an API user that can receive webhooks from Newsletter to set the send status on the sent messages in Communcation flow.

You can name the user to what you want but we recommend the following:

  • Display Name => Communication flow
  • Username => limepkg-communication-flow@limetech
  • Active => Yes
  • Type => API

Make sure to generate an API key and store it in Password state, it will be used later when configuring Web hooks from Lime Marketing

4. Go to configuration and choose your options

See configuration next.