Registration Completed

Event Key

ootb_registration

This event should be sent when a user submits or updates their registration information (e.g., starts or completes sign-up).

Event Key	Event Name	Type
`ootb_registration`	Registration	Simple event

⚠️
Note: Real-Time Attribute Sync This event serves a dual purpose: it tracks the user's activity and automatically updates the Customer Attributes (Customer Data) in real time. Any values passed in this event will overwrite existing data in the customer profile.

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 event:

{
  "context": {
    "ootb_email": "[email protected]",
    "ootb_mobile_number": "+1234567890",
    "ootb_status":"Started" / "Completed",
    "ootb_registration_source": "product page",
    "ootb_date_of_birth": "1990-01-15",
    "ootb_allow_email": "Yes",
    "ootb_allow_sms": "Yes",
    "ootb_allow_push": "Yes",
    "ootb_allow_whatsapp": "Yes",
    "ootb_is_email_verified": true,
    "ootb_is_mobile_verified": true,
    "ootb_is_blocked": false,
    "ootb_is_test": false,
    "ootb_gender": "male",
    "ootb_country": "US",
    "ootb_city": "NYC",
    "ootb_address": "Street 1111",
    "ootb_first_name": "John",
    "ootb_last_name": "Doe",
    "ootb_language": "en",
    "ootb_currency": "USD",
    "ootb_brand": "",
    "ootb_alias": "johndoe90",
    "ootb_referral_type": "Advertising",
    "ootb_affiliate_id": "",
    "ootb_platform": "iOS",
    "ootb_promo_code": "WELCOME2024",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

📘
Events-based Integration (EBI): parameter classification
The Events-based Integration column shows how each parameter is treated when you onboard using an Events-based Integration:

Mandatory — required for the event to be ingested and processed correctly.

Mandatory if required for the execution channel integration — required only when the relevant execution channel (e.g., email, SMS, push, WhatsApp) is part of your integration.

Enrichment- used for out-of-the-box attribute — not required, but when provided it powers an Optimove out-of-the-box attribute.

Optional — accepted and stored when provided; not required and not tied to an OOTB attribute.

Parameter Key	Type	Description	Events-based Integration
`ootb_email`	String	The customer's email address.	Mandatory if required for the execution channel integration
`ootb_mobile_number`	String	The customer's mobile phone number.	Mandatory if required for the execution channel integration
`ootb_status`	String	Registration status: `Started`, `Completed`, or `Failed`.	Optional
`ootb_registration_source`	String	Where registration was initiated (e.g., product page, checkout, header).	Optional
`ootb_date_of_birth`	String	The customer's date of birth in ISO format (YYYY-MM-DD).	Enrichment- used for out-of-the-box attribute
`ootb_allow_email`	String	Consent to email notifications (`Yes`/`No`).	Mandatory if required for the execution channel integration
`ootb_allow_sms`	String	Consent to SMS notifications (`Yes`/`No`).	Mandatory if required for the execution channel integration
`ootb_allow_push`	String	Consent to push notifications (`Yes`/`No`).	Mandatory if required for the execution channel integration
`ootb_allow_whatsapp`	String	Consent to WhatsApp notifications (`Yes`/`No`).	Mandatory if required for the execution channel integration
`ootb_is_email_verified`	Boolean	Whether email is verified (true/false).	Enrichment- used for out-of-the-box attribute
`ootb_is_mobile_verified`	Boolean	Whether mobile number is verified (true/false).	Enrichment- used for out-of-the-box attribute
`ootb_is_blocked`	Boolean	Customer blocked status (true/false).	Enrichment- used for out-of-the-box attribute
`ootb_is_test`	Boolean	Test account flag (true/false).	Enrichment- used for out-of-the-box attribute
`ootb_gender`	String	Customer gender (e.g., `male`, `female`, `other`).	Enrichment- used for out-of-the-box attribute
`ootb_country`	String	Country code (e.g., `US`, `UK`).	Enrichment- used for out-of-the-box attribute
`ootb_city`	String	Customer’s city.	Enrichment- used for out-of-the-box attribute
`ootb_address`	String	Customer’s address.	Enrichment- used for out-of-the-box attribute
`ootb_first_name`	String	Customer’s first name.	Enrichment- used for out-of-the-box attribute
`ootb_last_name`	String	Customer’s last name.	Enrichment- used for out-of-the-box attribute
`ootb_language`	String	Customer’s language preference (e.g., `en`, `fr`).	Enrichment- used for out-of-the-box attribute
`ootb_currency`	String	Customer’s preferred currency code.	Enrichment- used for out-of-the-box attribute
`ootb_brand`	String	Brand identifier (optional—for gaming platforms).	Enrichment- used for out-of-the-box attribute
`ootb_alias`	String	Gaming alias or username.	Enrichment- used for out-of-the-box attribute
`ootb_referral_type`	String	How the user was referred (e.g., `SEO`, `Affiliate`, `Advertising`).	Enrichment- used for out-of-the-box attribute
`ootb_affiliate_id`	String	Affiliate identifier or name.	Optional
`ootb_platform`	String	Platform used during registration (e.g., `iOS`, `Android`, `Web`).	Enrichment- used for out-of-the-box attribute
`ootb_promo_code`	String	Promotional code applied during registration.	Optional
`ootb_license`	String	License or regulation identifier.	Optional

Updated 15 days ago

Did this page help you?