Inbox message metrics
UpdatedInbox messages follow a similar delivery patterns as regular in-app messages. This means that messages are sent but not displayed until the recipient returns to your website or app.
The major difference is that inbox messages aren’t “delivered” in the traditional sense. Rather, you’ll fetch and display messages to your audience when they open your notification inbox. When you mark a message as opened, we’ll report that it’s delivered as well. This means you’ll track opens and clicks using your inbox client, but the time between when you send a message and it actually appears to the user is dependent on your users’ behaviors.
your website or app?} b-.->|no, wait until they return to your website or app|b b-->|yes|c{Did they open
the inbox?} c-->|yes|d(Message is displayed
to the user) d-->f{Does the inbox send
markOpened when themessage is displayed?} f-->|yes|g(Message is opened) f-.->|no|h(Message is not opened) c-.->|no|e{Is the message expired?} e-->|no, wait for the user
to open the inbox|c e-..->|yes|i(Message expires and
is removed from the inbox)
Use the Inbox API to mark status and delete messages
In general, you’ll want to display the message when your audience opens the notification inbox. When users open the inbox and see your message, your inbox can report that the message was opened using the markOpened() method.
You’ll do the same thing to delete the message when a user wants to remove it from their inbox or if you want to track clicks on the message.
Use the following methods to update the message state and track engagement:
markOpened(): Mark the message as delivered and openedmarkUnopened(): Mark the message as delivered but not openedmarkDeleted(): Mark the message as deletedtrackClick(actionName?): Track a click on the message
Available metrics
Like other in-app messages, inbox messages have the following metrics. Note that the delivered metric is typically reported along with the opened metric when the message is opened, because, for inbox messages, “delivery” doesn’t really happen independently of visibility (as it might for email).
| Metric | Reported by | Description |
|---|---|---|
sent | Customer.io | The message was sent by the user. |
delivered | markOpened() | The message was delivered to the user. |
opened | markOpened() | The message was opened by the user. |
clicked | trackClick() | The message was clicked by the user. |
failed | Customer.io | We couldn’t send the message. This is typically caused by a liquidA syntax that supports variables, letting you personalize messages for your audience. For example, if you want to reference a person’s first name, you might use the variable {{customer.first_name}}. rendering issue. |
