Platform Events
iDialogue implements an Event-Based Architecture for automating digital experiences.
Many event types occur throughout the customer lifecycle; such as document merge, send, eSign and payment events.
Using Flow Builder, platform events can trigger followup actions and execute complex workflows without writing any code.
Many actions, conditions, and record updates can occur within a flow.
From Setup, search for “Platform Events” and click on “iDialogue Event” to see the schema for an event.
Each event has a Type. The first condition in an iDialogue flow will typically check the event type and branch based on the event type.
Click here for a detailed list of all platform event types
An Apex API utility class is available to assist with creating iDialogue events from Apex code.
Platform Event Schema
| Event Field | API Name | Data Type | Description |
|---|---|---|---|
| Attachment ID | rooms__AttachmentID__c | Text(255) | Reference to an Attachment or ContentVersionID. |
| Contact ID | rooms__ContactId__c | Text(255) | Reference to a CRM Contact ID |
| Content Document ID | rooms__ContentDocumentID__c | Text(255) | Reference to a Content Document ID |
| Content Version ID | rooms__ContentVersionID__c | Text(255) | Reference to a Content Version ID |
| Event Type | rooms__Type__c | Text(255) | The Event Type (required) see complete list of event types |
| Lead ID ID | rooms__LeadId__c | Text(255) | Reference to a CRM Lead |
| Message | rooms__Message__c | Long Text Area(131072) | Message details. Also JSON payload for extended messages |
| Origin ID | rooms__Origin__c | Text(255) | The event origin. Web, Mobile, Desktop |
| Record ID | rooms__RecordId__c | Text(255) | Reference to the document or room context |
| Record Type | rooms__RecordType__c | Text(255) | The CRM table name. Ex: Contact, Opportunity. |
| Room ID | rooms__RoomId__c | Text(255) | Reference to Room ID |
| Room Item ID | rooms__RoomItemId__c | Text(255) | Reference to Item ID (Document container) |
| Room Member ID | rooms__RoomMemberId__c | Text(255) | Member ID |
| Subject | rooms__Subject__c | Text(255) | Event Subject |
| Success | rooms__Success__c | Checkbox | If false, then message contains error details |
| Timestamp | rooms__Timestamp__c | Date/Time | Event Timestamp |
| User ID | rooms__UserId__c | Text(255) | Reference to CRM User |
| Value | rooms__Value__c | Number(12, 2) | Number value |