--- title: "Relay Package Configuration" slug: "relay-package-configuration" tags: ["sfdc", "setup"] updated: 2026-07-10T12:05:44Z published: 2026-07-10T12:05:44Z canonical: "docs.relaynetwork.com/relay-package-configuration" 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. # Custom Metadata UnmanagedManaged The Relay Custom Metadata **must** be configured upon the initial installation of the Relay package. > [!WARNING] > IMPORTANT > > You should only have one Relay Custom Metadata Type record. [Video](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/SFDC%20Installation%20-%20Set%20Up%20Custom%20Metadata.mp4) 1. Access your org’s Setup page 2. Navigate to *PLATFORM TOOLS → Custom Code → Custom Metadata Types* 3. In the right pane locate *Relay Network Settings* and click **Manage Records** 4. Click the **New** button to create a new record. If a record already exists click on the **Edit** button. 5. Fill out the Relay Network Settings metadata as follows ![Relay Network Settings Metadata](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/um-metadata.png) ## Information | Field | Description | | --- | --- | | Label | Relay recommends setting this value to **Relay Settings** | | Relay Network Setting Name | Relay recommends setting this value to **RelaySettings** | | Default Client ID | Provide the Relay Client ID given to you by your Relay Implementation Manager. This value serves as the default client ID whenever a Relay Lightning Web Component (LWC) or Flow Action requires a client ID value, and it remains unspecified. | | Ext Fields | This field is being deprecated and should no longer be used. Please use the Ext property on the Relay LWC and Relay Flow Actions. | | Enable Multiple Clients | This option is rarely used and should be left unchecked. Your Relay Implementation manager will inform you if this setting is required for your business. See: [Named Credentials](/v1/docs/configure-named-credentials) for more settings associated with multi-client setup | ## Account Object These settings are used by the [Relay Account Trigger](/docs/relay-account-trigger) and the [Relay Event Trigger](/v1/docs/relay-event-trigger). | Field | Description | | --- | --- | | Account CCID Field Name | This field is utilized by the **Relay Events** trigger. If the field storing the Relay CCID is not maintained within the **Account** object, you may leave this field blank. | | Account Relay Consent Field Name | The field name where the Relay consent value is stored. If you're not storing TCPA consent with the Account object: - You can leave this field blank. - You should disable the Relay Account Trigger (below). | | Account Mobile Phone Field name | The field name where the user's mobile number is stored. If you're not storing TCPA consent with the Account object: - You can leave this field blank. - You should disable the Relay Account Trigger (below). | ## Contact Object These settings are used by the [Relay Event Trigger](/v1/docs/relay-event-trigger) | Field | Description | | --- | --- | | Contact CCID Field Name | This field is utilized by the Relay Events Trigger. If the field storing the Relay CCID is not maintained within the Contact object, you may leave this field blank. | ## Account Trigger | Field | Description | | --- | --- | | Disable | The Relay package contains an Account trigger that monitors SMS TCPA consent changes within your Salesforce org and forwards these changes to Relay. If you do not store SMS TCPA consent with the Account, please check this box to deactivate the Relay Account Trigger. | ## RelayEvents Trigger These settings control what logic the Relay Event Trigger will preform. Please review the [Relay Event Trigger](/v1/docs/relay-event-trigger) article for a complete description on its processing logic. | Field | Description | | --- | --- | | Disable TCPA Consent Processing Logic | When enabled (unchecked), the **Relay Event Trigger** will handle incoming TCPA consent changes from Relay. Ensure that the **Account** section above is properly configured. When disabled (checked), the **Relay Event Trigger** will not execute any TCPA consent logic. It will be your responsibility to manage all consent change events from Relay. | | Disable Account Ref Lookup | When enabled (unchecked), the Relay Event Trigger will try to link the *Relay Event* record with an *Account* record. Please ensure that the **Account** CCID Field Name is correctly configured in the section above. When disabled (checked), no account lookup will occur, and the **Account__c** field on the *Relay Event* record will remain null. | | Disable Contact Ref Lookup | When enabled (unchecked), the **Relay Event Trigger** will try to link the *Relay Event* record with an *Account* record. Please ensure that the **Account** CCID Field Name is correctly configured in the section above. When disabled (checked), no contact lookup will occur, and the **Contact__c** field on the *Relay Event* record will remain null. | The Relay Custom Metadata **must** be configured upon the initial installation of the Relay package. > [!WARNING] > IMPORTANT > > You should only have one Relay Custom Metadata Type record. 1. Access your org’s Setup page 2. Navigate to *PLATFORM TOOLS → Custom Code → Custom Metadata Types* 3. In the right pane locate *Relay Network Settings* and click **Manage Records** 4. Click the **New** button to create a new record. If a record already exists click on the **Edit** button. 5. Fill out the Relay Network Settings metadata as follows ![](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/m-metadata.png) ## Information | Field | Description | | --- | --- | | Label | Relay recommends setting this value to **Relay Settings** | | Relay Network Setting Name | Relay recommends setting this value to **RelaySettings** | ## General Settings | Field | Description | | --- | --- | | Default Client ID | Provide the Relay Client ID given to you by your Relay Implementation Manager. This value serves as the default client ID whenever a Relay Lightning Web Component (LWC) or Flow Action requires a client ID value, and it remains unspecified. | | Enable Multiple Clients | This option is rarely used and should be left unchecked. Your Relay Implementation manager will inform you if this setting is required for your business. See: [Multiple Relay Clients in a Single Org](/v1/docs/multiple-relay-clients-in-a-single-org#1-enable-multiclient-support) | ## RelayEvents Trigger These settings control what logic the Relay Event Trigger will preform. Please review the [Relay Event Trigger](/v1/docs/relay-event-trigger) article for a complete description on its processing logic. | Field | Description | | --- | --- | | Disable Account Ref Lookup | When enabled (unchecked), the Relay Event Trigger will try to link the *Relay Event* record with an *Account* record. Please ensure that the **Account** CCID Field Name is correctly configured in the section above. When disabled (checked), no account lookup will occur, and the **Account__c** field on the *Relay Event* record will remain null. | | Account CCID Field Name | If the **Account Ref Lookup** is not disabled, then you must enter the field name, on the **Account** object, that contains the Relay CCID value. | | Disable Contact Ref Lookup | When enabled (unchecked), the **Relay Event Trigger** will try to link the Relay Event record with an **Account** record. Please ensure that the **Account** **CCID** Field Name is correctly configured in the section above. When disabled (checked), no contact lookup will occur, and the **Contact__c** field on the **Relay Event** record will remain null. | | Contact CCID Field name | If the **Contact Ref Lookup** is not disabled, then you must enter the field name, from the **Contact** object, that contains the Relay CCID value. | ## 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. 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. 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. Telephone Consumer Protection Act (TCPA) requires that the recipient of the SMS (your customers) must grant permission for you to send them text messages