Registration Initiated

Event Key

ootb_registration_initiated

This event should be fired when a registration process started from the user side, mainly to monitor uncompleted processes and trigger campaigns accordingly.

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Registration Initiated event:

{
  "context": {
    "ootb_session_id": "sess_9232uhf8",
    "ootb_form_location": "homepage",
    "ootb_referral_source": "facebook",
    "ootb_language": "en"
  }
} 

Parameters

Explanation

• event: Set to ootb_registration_initiated to indicate a user began filling out the registration form.
• context:
  • ootb_session_id: Links the event to the user’s browser session.
  • ootb_form_location: Indicates where the form was shown (e.g., homepage).
  • ootb_referral_source, ootb_language: Provide context on the user’s source and locale.

Additional Parameters

Beyond the parameters listed above, you can include additional parameters in the event. If an additional parameter corresponds to an existing profile attribute, its value is used to update that profile attribute.

Optimove resolves each additional parameter as follows:

1. Parameters with the ootb_ prefix — the ootb_ prefix is removed and the remaining parameter name is matched against profile attribute names. If a matching profile attribute exists, it is updated. For example, ootb_first_name: "John Doe" updates the first_name profile attribute.
2. ootb_is_mobile_verified and ootb_platform — these two are special-cased. Their values populate is_sms_verified and registered_platform respectively, rather than following the prefix-stripping rule above.
3. Parameters without the ootb_ prefix — the parameter name is matched directly against profile attribute names. If a matching profile attribute exists, it is updated. For example, loyalty_tier: "Gold" updates the loyalty_tier profile attribute.
4. No matching profile attribute — if no profile attribute with the corresponding name exists, the parameter is ignored. The event is still ingested; only the unmatched parameter is dropped.

Example

{
"tenant": 567,
"timestamp": "2024-05-27 10:30:00.000000 UTC",
"event": "ootb_registration",
"customer": "customerId1",
"context": {
  "ootb_first_name": "John",
  "ootb_is_mobile_verified": true,
  "ootb_platform": "iOS",
  "loyalty_tier": "Gold",
  "ootb_favourite_sport": "tennis"
  }
}

In this payload:

• ootb_first_name updates the first_name profile attribute (rule 1).
• ootb_is_mobile_verified updates is_sms_verified (rule 2).
• ootb_platform updates registered_platform (rule 2).
• loyalty_tier updates the loyalty_tier profile attribute (rule 3).
• ootb_favourite_sport is ignored if no favourite_sport profile attribute exists (rule 4).