Docs
Sign up now
  • Getting started
    • Welcome to Sortment
    • Core Concepts
  • Schema
    • Overview
    • Related and Events Table
    • Setting Up Related Table
    • Setting Up Events Table
    • Custom Properties
  • ENGAGE
    • Audiences
      • Creating Audience Using Visual Builder
      • Audience Filters
      • Campaign Event Filters
      • Creating Audience Using SQL Builder
      • Managing Audiences
      • Sync Schedule
      • Audience Insights
    • Campaigns
      • Overview
      • Building a Campaign
      • Campaign Reports
        • Glossary
      • Conversion Tracking
  • Profiles
    • User Profile View
  • Traits
    • Use Cases
    • Calculated Traits
      • Advanced Mode
    • Dynamic Traits
  • Setup
    • Data Warehouses
      • Snowflake
      • BigQuery
      • Redshift
      • Databricks
      • PostgreSQL
    • Cloud Bucket Storage
      • Amazon S3 for Snowflake
      • Google Cloud Storage for BigQuery
      • Amazon S3 for Redshift
      • Amazon S3 for Databricks
    • Communication Channels
      • Email
        • SendGrid
        • SES
        • Mailmodo
      • SMS
        • MSG91
        • Gupshup
      • WhatsApp
        • Meta (Facebook)
          • Add new Phone Number to Meta
        • Gupshup Enterprise
        • WATI
        • Gallabox
        • Yellow.ai
        • Kaleyra.io
    • Real-time Events
      • Setting up Event Source
      • Whitelist Event Payload
  • Sync Schedules
  • Audit Logs
  • Subscription Groups And Contact Fields
  • Delivery Controls
  • Alerts
  • Handlebars
  • Test Profiles
  • Data and Security
    • Technical Overview
    • Warehouse Data Practices
    • Data Access And Usage
    • Security Compliance
    • Audit Logs
    • Privacy Policy
Powered by GitBook
On this page

Was this helpful?

  1. Setup
  2. Real-time Events

Whitelist Event Payload

To use any event in Journeys, it needs to be whitelisted on respective source. Here are the steps to whitelist an event payload and its properties on Sortment:

  1. Navigate to Sortment Events tab, represented by the Mouse Pointer icon.

  2. Click on the Add Event button to start setting up a new event. You can either start from scratch or clone an existing event if the event payload structure for this event matches an existing whitelisted event.

  3. Choose Source from the dropdown and Add sample Event JSON payload. This should be a valid JSON to proceed. Click Next.

  4. Setup the reserved keys by selecting the keys from the payload. Once done, click Next.

    1. User ID: Unique identifier for the user.

    2. Distinct ID: Unique identifier for each event.

    3. Timestamp: Time of event action. This should be in ISO-8601 format.

  5. Whitelisting event prperties is mandatory to use them in journeys. To whitelist event properties other than reserved keys, click Add Properties button.

  6. In the popup, select keys from the event payload and Click Save.

  7. For each key, pick a Label from existing list or create a new label and set the datatype for this field. This will validate the event key value during event ingestion. Once done, click Next.

  8. To name the event, two values are necessary:

    1. Event Name (as received in the payload): This must match the name as sent in the payload to Sortment (including capitalization, spaces, etc.)

    2. Event Label: Concise and readable label for this event. This will be used to identify the event on Sortment in events manager and journeys.

PreviousSetting up Event SourceNextSync Schedules

Last updated 7 months ago

Was this helpful?