Page updated Jan 16, 2024

Display messages

In-app messages are displayed when an In-App Messaging or analytics event is sent and matches the criteria set forth by your active In-App Messaging campaigns.

Analytics event

Now that messages have been synced to your users’ devices, Amplify In-App Messaging will allow you to start displaying them with Amplify Analytics events with no additional integration steps. Any events you record or are already recording using the Analytics.record API are automatically picked up and processed by In-App Messaging. If the event matches the attributes and criteria defined in an in-app message, that message will be displayed.

import { Analytics } from 'aws-amplify'; const event = { name: 'first_event', attributes: { color: 'red' }, metrics: { quantity: 10 } }; Analytics.record(event);
1import { Analytics } from 'aws-amplify';
2
3const event = {
4 name: 'first_event',
5 attributes: { color: 'red' },
6 metrics: { quantity: 10 }
7};
8
9Analytics.record(event);

If the event name, attributes, and metrics match those set forth by one of your In-App Messaging campaigns, you should see the in-app message displayed in your app.

In-App Messaging event

In addition to or instead of Amplify Analytics events, you can also dispatch In-App Messaging events to trigger an in-app message display programmatically.

const event = { name: 'first_event', attributes: { color: 'red' }, metrics: { quantity: 10 } }; InAppMessaging.dispatchEvent(event);
1const event = {
2 name: 'first_event',
3 attributes: { color: 'red' },
4 metrics: { quantity: 10 }
5};
6
7InAppMessaging.dispatchEvent(event);

If the event name, attributes, and metrics match those set forth by one of your In-App Messaging campaigns, you should see the in-app message displayed in your app.