---
title: "RelayEvents__c"
slug: "relayevents-c"
updated: 2026-02-25T17:38:22Z
published: 2026-02-25T17:38:22Z
canonical: "docs.relaynetwork.com/relayevents-c"
excludeFromExternalSearch: true
---

> ## 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.

# RelayEvents__c

The **RelayEvents__c** object is automatically created during the package install. This object contains many different types of events that are emitted from the Relay Platform. These events include messaging, SMS notifications, end user engagement, power-up form submissions and TCPA consent changes.

Because this object is used for a variety of event types, not every field in the object will be populated for each event type. Please review the Relay Events Type section below for specifics on each event type.

> [!NOTE]
> Note
> 
> In order for the RelayEvent__c object to receive event data from Relay, the [Relay Connected App Configuration](/v1/docs/connected-app#overview) must be completed.

| Field | Description |
| --- | --- |
| Account__c | Contains a reference to the associated Account object. This field is populated by a trigger on the **RelayEvents__c** object which looks up the Account based on the CCID field value. If an Account is not found, then this field is left null. |
| Account_18_Digit_id__c | Contains the 18 digit (case insensitive) Account Id. If the Account field is null, then this field will be blank |
| ActionLabel__c | Contains the text of the action label that was clicked. This value is specified in the Relay CXB. |
| ActionValue__c | Contains the value associated with the action. This value is specified in the Relay CX Builder. |
| ChannelAddress__c | The mobile number associated with the event |
| ChannelType__c | Identifies the channel type associated with the consent change. Valid values are: **sms** → A mobile number channel. |
| ClientMessageTag__c | This is a pass-through field provided by the Client. |
| ClientId__c | Contains your unique Client identifier within the Relay platform. This field will always be populated. |
| Contact__c | Contains a reference to the associated Contact object. This field is populated by a Trigger on the RelayEvents__c object which looks up the Contact based on the CCID field value. If no Contact is found then this field is left null. |
| CreatedBy__c | Contains the salesforce user that created the record. This is the user that was configured as part of the Connected App Setup See: [connected-app-user]. |
| CurrentConsent__c | Contains the current TCPA consent value for the mobile number identified by the ChannelAddress field. |
| CustomerId__c | Contains the internal Relay customer identifier. |
| DataCaptureID__c | The unique identifier of the power-up field. This ID is specified in the Relay CX Builder. |
| DataCaptureLabel__c | The power-up field label as presented to the end user. |
| DataCaptureValue__c | The power-up field value as provided by the end user. |
| EventId__c | A unique identifier for the event. Every event will have a unique EventId. |
| EventSubType__c | The sub event type. See the Event Types section below for complete details. |
| EventTimestamp__c | The date and time when the event was generated. |
| EventType__c | The event type. See the Event Types section below for complete details. |
| JobId__c | Contains the internal Relay Job Id associated with the event. Not all events will contains a job Id value. |
| JourneyID__c | Contains the unique Experience Id associated with the event. |
| LastModifiedById__c | Standard Salesforce field that identifies the user that last modified the record. |
| Lb_name__c | Contains the name of the user or service that originated the initial event such as onboarding or messaging. |
| Lb_source__c | Contains the name of the service that originated the initial event onboarding or messaging. All subsequent related |
| MessageID__c | Identifies the specific Relay Experience message identifier associated with the event. |
| MessageName__c | Contains the Relay Experience message name associated with the event. |
| Name__c | Contains the name of the specific event. |
| NotificationID__c | Contains the Relay internal notification Id associated with the event. |
| PreviousConsent__c | Contains the previous TCPA consent value. This field is only populated for channel_consent event types. |
| PreviousConsenttType__c | Currently not used. |
| ProductGroupID__c | Contains the Relay product group id associated with the CCID field. |
| RelayCCID__c | Contains the CCID associated with this event. |
| RelayTrackingId__c | Contains an internal Relay tracking Id for the event record. This is an optional field and may be blank. |
| SourceChannel__c | Contains the source channel where the event originated from. |
| TriggerID__c | Contains the Trigger ID of the Relay experience this event is related to. |
| TriggerNickname__c | Contains the nickname (friendly name) associated with the Relay experience. |

## Relay Event Types

> [!NOTE]
> NOTE
> 
> You will see in the documentation references to the term **wire**. **Wire** is synonymous with **Feed**. **Wire** is the original term used to describe our mobile technology. Because many existing clients have already created existing integration that may rely on the old term we have to maintain it for backwards compatibility.

| Name | EventType__c | EventSubType__c | Description |
| --- | --- | --- | --- |
| Data Capture | data_capture | success | A user completed a Relay power-up form an submitted it. |
| Consent Updated | channel_consent | update | TCPA SMS consent event for a specific user. Consent changes can happen outside of any specific message or notification therefore, the message and trigger related event fields will **not** be populated. Notable Fields: **CurrentConsent__c →** Contains the current TCPA consent value for the user. **PreviousConsent__c →** Contains the previous TCPA consent value for the user. > [!NOTE] > NOTE > > It is possible for both the *CurrentConsent__c* and *PreviousConsent__c* values to be the same. This can happen when a user’s profile is updated but there is no actual change in consent value. Or when responding to an external consent change request either from the user or from your org. |
| Message: Added to wire | message | delivered | The message was posted to the user’s Feed. This does imply an SMS notification has been sent. Notable Fields: **ChannelAddr__c →** The channel address is not populated for this event as posting a message to a user feed is separate from notifications. |
| Message: Not Added to wire | message | undelivered | The message failed to the posted to the user’s Feed. Notable Fields: **ActionValue__c →** Identifies the reason why the message not posted (delivered) to the Feed. |
| Message: Opened | notification | auth_link_used | The user clicked the *auth_link* in the SMS. Notable Fields: **ChannelAddr__c →** The mobile number associated with this notification event. |
| Message: Branch action taken | action | message_branch | The user clicked a message branch button and navigated to the related message card. Notable Fields: **ActionLabel__c →** The text describing the branch action. **ActionValue__c →** The internal UUID of the branch action. |
| Message: Call action taken | action | call | The user clicked the call action in the Feed. Note, this does not imply an actual phone call was made as the user may decide to cancel the mobile call. Notable Fields: **ActionLabel__c →** The text describing the call action. **ActionValue__c →** The phone number associated with the call action. |
| Message: Hyperlink action taken | action | hyperlink | The user clicked a hyperlink in the Feed. Notable Fields: **ActionLabel__c →** The text describing the hyperlink action. **ActionValue__c →** The hyperlink (URL) value |
| Message: Opened collapsible section | action | collapsible | A user clicked to expand a collapsible section of content in the Feed. Notable Fields: **ActionLabel__c →** The text describing the collapsible section. **ActionValue__c →** The internal UUID of the collapsible section. |
| SMS: Attempted | notification | attempted | An SMS notification has been sent to the carrier for delivery. Notable Fields: **ChannelAddr__c →** The mobile number associated with this notification event. |
| SMS: Not Attempted | notification | not_attempted | The SMS notification was not attempted thus not sent to the carrier. Notable Fields: **ChannelAddr__c →** The mobile number associated with this notification event. |
| SMS: Delivered | notification | delivered | An SMS notification was successfully sent by the carrier to the mobile number. Notable Fields: **ChannelAddr__c →** The mobile number associated with this notification event. |

Triggering refers to sending the user an SMS text message that contains a personalized URL. The URL will take the user to their personalize Feed.

Client Customer ID - Uniquely identifies a client's customer within the Relay system. Each customer must have a unique ID. This value can be different from the actual customer ID within the client's system although maintaining the mapping between the IDs is the responsibility of the client.

Telephone Consumer Protection Act (TCPA) requires that the recipient of the SMS (your customers) must grant permission for you to send them text messages

Every message experience created in the Relay CXB is automatically assigned a unique Trigger ID. Once assigned, the Trigger ID never changes. This ID is used when you send a message to a customer/user. However, you do have the ability to associate a unique, friendly client trigger ID to the message that is easier to remember.

Wire is the original term used to describe our mobile technology. The new term is **Feed**. However, you will still see the term **wire** being used in our integration documentation as changing the term there could break existing client integrations or reporting.