---
title: "Adding the Relay Component to a Page"
slug: "adding-the-relay-component-to-a-page"
tags: ["sfdc", "lwc"]
updated: 2026-10-29T19:49:24Z
published: 2026-10-29T19:49:24Z
canonical: "docs.relaynetwork.com/adding-the-relay-component-to-a-page"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.relaynetwork.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Adding the Relay Message List LWC to a Page

> [!WARNING]
> IMPORTANT
> 
> - You must have the proper permissions to edit Salesforce pages.
> - You must have configured a [Connected App](/docs/connected-app) to Relay in order for the message status values to be displayed.

The **Relay Message List** LWC can be placed on any record page that supports editing the page layout.

## Adding the Relay LWC to a Page

[Video](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/SFDC%20Configuration%20-%20LWC_%20Adding%20LWCv2.mp4)

1. Go to the record page you want to place the Relay component. In this example we will be adding the component to the *Case* record page.
2. Click the **gear** (Fig. 1-1) and select **Edit Page** (Fig 1-2).

![rn-sfdc-lwc-edit_page](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/rn-sfdc-lwc-edit_page.png)

Fig. 1 - Edit Page Layout

1. Locate the **Relay Message List** component under the *Custom* section (Fig. 2-4)
2. Drag the component to your desired location (Fig. 2-5). In this example we are dragging the component to a new tab, *Relay Network*, that was created on the case record (Fig. 2-6).

![rn-sfdc-lwc-add-component](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/rn-sfdc-lwc-add-component.png)

Fig. 2 - Page Builder

1. Once the Relay component has been added to the page layout, click on it to open its property editor. The property editor will be opened on the right side of the window. See the next section for a complete description of all the component’s properties.

## Relay Message List Component Elements

![rn-sfdc-lwc-experience_list_layout](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/rn-sfdc-lwc-experience_list_layout.png)

Fig 3. Relay LWC

- (Fig. 3-1) - Within the Relay CXB, messages are added to a collection called *experiences.* Each experience can contain one or more messages. The component displays all of the filtered experiences (see the next article for details on configuring the component). Experiences can be expanded to show the individual messages.
- (Fig. 3-2) - This is the message preview icon. Clicking on it will present the agent with a preview of the message content. Currently, this functionality does not include previewing images or videos that might be in the message.
- (Fig. 3-3) - This is the description of the message.
- (Fig. 3-4) - This section provides the sending status of the message. When sending a message it will go through several status changes including *Pending, Posted (or not posted), SMS Delivered (or not delivered).* Posted refers to posting the message to the user’s Feed.
- (Fig. 3-5) - This section provides the status of when a user has clicked on the SMS to view the message.
- (Fig. 3-6) - Clicking the send button will open a confirmation dialog. The confirmation dialog presents to the agent the user’s name, mobile number, and which message will be sent as a final confirmation before sending.
- (Fig. 3-7) - If any errors occur during the send process, the error status will be displayed along with an (i) icon. Hovering your cursor over the (i) icon will display a brief description of the error that occurred.

### Relay Message Status Values

The Relay message status of sending (Fig. 3-4 )and viewing (Fig. 3-5) are calculated from [RelayEvent__c](/docs/relayevents-c) records that have been pushed to your org.

#### Message Send Status

The table below outlines the [RelayEvents__c](/docs/relayevents-c) records that control the message status value (Fig. 3-4).

> [!NOTE]
> NOTE
> 
> A Relay message does not always have an accompanying SMS notification.

| EventType__c | EventSubType__c | Description |
| --- | --- | --- |
| message | delivered | The message was delivered (posted) to the user’s Feed. |
| message | undelivered | The message failed to be delivered to the user’s Feed. Some common reasons for failures are: - Duplicate message suppression is in effect. Relay prevents the same exact message from being posted to the Feed within a 10 minute time frame. - Missing dynamic input_ parameters. If a message requires dynamic input_ parameters and all of them are not provided and an alternate message is not provided, the message will fail to post. |
| notification | delivered | The SMS message was successfully delivered to the mobile device. |
| notification | undelivered | The SMS message failed to be delivered to the mobile device. There are many reason why |
| notification | not_attempted | The SMS message was not attempted. The most common reasons why an SMS message would not be attempted are: - A blackout window is in effect. Once the blackout window has passed the notification will be attempted. - Spam suppression is in effect. Relay has a system in place to prevent sending too many messages to a single mobile device within a short period of time. |

#### Message Viewed Status

The table below outlines the [RelayEvents__c](/docs/relayevents-c) records that control the message viewed status (Fig. 3-5).

| EventType__c | EventSubType__c | Description |
| --- | --- | --- |
| notification | auth_link_used | The user clicked on the SMS notification. |

Lightning Web Components (LWC) is the Salesforce implementation of that new breed of lightweight frameworks built on web standards. LWCs are the building blocks of the Salesforce visual user interface you interact with in your web browser.