RelayPowerups__c
  • 13 Nov 2024
  • 2 Minutes to read
  • Dark
    Light

RelayPowerups__c

  • Dark
    Light

Article summary

The RelayPowerups__c object is automatically created during the package install. This object contains several different types of events that are emitted from the Relay Platform. These events are specific to the Relay Power-Ups service.

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. 

IMPORTANT

In order for the RelayEvent__c object to receive event data from Relay, the Connected App configuration must be completed.

NOTES

  1. One record will be created for each power-up field on the form. So if a power-up form contains ten fields, ten records will be created; one for each form field.

  2. Currently, the Relay package does not leverage the data in the RelayPowerups__c object. Therefore, you can freely cleanup (delete) the records based on your requirements.

Field

Description

Client_id

Contains your unique Client identifier within the Relay platform. This field will always be populated.

ClientMessageTag__c

This is a pass-through field provided by the Client.

CustomerId__c

Contains the internal Relay customer identifier.

DateSubmittedAt__c

The data and time the form was submitted.

EventID__c

A unique identifier for the event. Every event will have a unique Event ID.

EventTimestamp__c

The date and time the event was generated.

FormID__c

The Power-up Form ID associated with this event.

JourneyID__c

Contains the unique Experience ID associated with the event.

MessageID__c

Identifies the specific Relay Experience message identifier associated with the event.

Name

The name of the event.

Valid values are:

  • Powerups Data Received

  • Powerups PDF Data Received

See the Power-up Event Types section below for detailed descriptions of each event type.

ProductGroupID__c

Identifies the Relay product group ID associated with the Relay CCID at the time the form was submitted.

RelayCCID__c

CCID

RelayTrackingId__c

An internal tracking identifier leveraged by Relay.

SubmissionAnswerId__c

Uniquely identifies the answered question for the power-up form.

SubmissionID__c

Contains the power-up form submission ID. Every power-up form submission, even from the same CCID, will contain a different submission ID.

SubmissionType__c

Identifies the question’s field type.

SubmissionValue__c

The submitted value (answer) for the specific question.

TriggerID__c

Identifies the Relay trigger ID associated with the message that contained the power-up form.

TriggerNickname__c

This optional field may contain a client provided trigger nickname.

Power-up Event Types

Powerups Data Received

A Powerups Data Received record is created for every field of a submitted form. So if you have one-thousand people filling out a form that contains ten fields, ten-thousand power-up event records will be created.

Powerups PDF Data Received

IMPORTANT

Your power-up form must have been configured to generate PDFs for this event to be emitted. Please reach out to our Relay Client Success Manager for more details.

A Powerups PDF Data Received record is created when a PDF has been generated, for the form, and is ready to be downloaded.


Was this article helpful?

What's Next
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence