Regal · JSON Structure

Regal Event Structure

Structural description of a Regal custom event payload.

Type: Properties: 0
AIAI AgentsVoice AIContact CenterOutbound CallingInbound CallingPhone AgentsSMSChatWebRTCConversation IntelligenceJourney OrchestrationBranded Caller IDCCaaSCPaaSSales DialerCustomer Engagement

RegalEvent is a JSON Structure definition published by Regal. It conforms to the https://json-structure.org/draft-00/schema meta-schema.

Meta-schema: https://json-structure.org/draft-00/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft-00/schema",
  "name": "RegalEvent",
  "description": "Structural description of a Regal custom event payload.",
  "fields": [
    { "name": "userId", "type": "string" },
    { "name": "traits", "type": "RegalContact" },
    { "name": "name", "type": "string", "required": true, "description": "Event name. Used to trigger matching Journeys." },
    { "name": "eventId", "type": "string", "description": "Unique event identifier (present on webhook deliveries)." },
    { "name": "properties", "type": "map<string, any>" },
    { "name": "originalTimestamp", "type": "string" },
    { "name": "eventSource", "type": "string" }
  ]
}