The ComUnity Platform utilises an event-driven architecture to facilitate communication. Events are exposed through a REST API and can be easily triggered with a simple POST request. As part of our low-code platform, we provide a convenient helper function, CommsService.TriggerEvent(), to simplify this process.
Communication Events are typically associated with individual entities and are commonly triggered within change interceptors. As a developer, you can create these events and define dynamic action templates for each event. These templates govern the behaviour and delivery of communications across diverse channels, including email, in-app messaging, push notifications, HTTP, WhatsApp, and SMS.
To create an event follow these steps:
Open your project in the Toolkit and navigate to the Communications section to view a list of all the events currently associated with your project, if there are any.
Locate the (+) Add an event button and click on it to add a new event to your Communications.
A modal window titled Add New Event will appear on your screen.
From the dropdown menu, select the entity you want to link the event to.
Select the appropriate change interceptor for the event.
Optionally, provide a name for your event.
Finally, click the Add button to add the entity to the Communications module.
After setting up the event, you can proceed to configure templates to define the behaviour and delivery of communication for that event. Templates provide you with the flexibility to customise the content and format of communication across different channels.
To customise an event template, follow these steps:
Event Details: This tab allows you to specify important details related to the event template. View Event Details: Understanding Data Sources for Dynamic Template Building to learn more about configuring event details.
Communication Channels : In the modal window, you will find multiple tabs representing different communication channels supported by the event template. Each tab corresponds to a specific communication channel, such as email, in-app messaging, push notifications, HTTP, WhatsApp, and SMS. Click on each tab to explore the available options and settings for configuring communication channels.
By navigating through these tabs, you can fine-tune the event template according to your requirements, ensuring effective communication across multiple channels.
To learn more about event details and configuring specific communication channels, click the links below:
When customising an event template, you can access the template settings by clicking the edit icon for the desired event. This action opens a modal window with various tabs representing different aspects of the template configuration.
Click the edit icon for the desired event. This action opens a modal window with various tabs representing different aspects of the template configuration.
