Skip to content

Platform Event Types

Event TypeDescriptionPopulated Fields See schema
INFOAn informational event. Typically for use in debugging and troubleshooting.Subject, Message
ERRORAn error event. Typically the result of an unhandled exception.Subject, Message
SITE_PUBLISHRaised when a room/portal template is published. RecordID refers to a SiteDefinitionData__c record.Subject, Message, RecordID
ROOM_CREATERaised when an room is created.Subject, Message, RecordID, RoomID
ROOM_COMMENTRaised when a comment is added to a room.Subject, Message, MemberID, RoomID
ROOM_CLOSERaised when an room is closed.Subject, Message, RoomID
ROOM_COMPLETERaised when all actions in a room are completed. Typically in a checklist.Subject, Message, RoomID
ROOM_VIEWRaised when a room is viewed.Subject, Message, RoomID, RecordID
MEMBER_ADDRaised when a Lead or Contact is added to a room.Subject, Message, RoomID, MemberID
MEMBER_INVITERaised when a member is sent an invite to a room.Subject, Message, RoomID, MemberID
MEMBER_SIGNINRaised when a member is authenticated to a room (portal context)Subject, Message, RoomID, MemberID
MEMBER_SIGNOUTRaised when a member initiates a signout from a portal roomSubject, Message, RoomID, MemberID
DOCUMENT_GENERATERaised when a record is generated from a merge template in a room context.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_MERGERaised when a record is merged with a document template.Subject, Message, RecordID, AttachmentID, ContentDocumentID, ContentVersionID
DOCUMENT_SENTRaised when a document is sent to a room member.Subject, Message, RoomID, ItemID, RecordID
DOCUMENT_ATTACHEDRaised when a document is attached to a record. Occurs simultaneously with an ESIGNED event.Subject, Message, RoomID, ItemID, MemberID, RecordID, AttachmentID
DOCUMENT_VIEWOccurs when a document is clicked on and viewed.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_REVIEWEDRaised by the Review action button types.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_AGREERaised by the Agree action button types.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_APPROVERaised by the Approve action button types.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_DECLINERaised by the Reject action button types.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_COMMENTRaised when a comment is added to a document.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_UPLOADRaised when a document is uploaded to a room.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_SHARERaised when a document is shared or forwarded.Subject, Message, RoomID, ItemID, MemberID, RecordID
DOCUMENT_ESIGNEDRaised when a document eSigned.Subject, Message, RoomID, ItemID, MemberID, RecordID, AttachmentID
DOCUMENT_COMPLETERaised when a document is completed. Either of the above actions: Reviewed, Agreed, Rejected, ESigned.Subject, Message, RoomID, ItemID, MemberID, RecordID
MESSAGE_CREATERaised when a message is created.Subject, Message, RoomID, ItemID, MemberID, RecordID
MESSAGE_READRaised when a message is read.Subject, Message, RoomID, ItemID, MemberID, RecordID
MESSAGE_DELETERaised when a message is deleted.Subject, Message, RoomID, ItemID, MemberID, RecordID
FORM_OPENSubject, Message, RoomID, ItemID, MemberID, RecordID
FORM_CLOSESubject, Message, RoomID, ItemID, MemberID, RecordID
FORM_SUBMITRaised when a form is submitted.Subject, Message, RoomID, ItemID, MemberID, RecordID
FORM_INPUT_OPENSubject, Message, RoomID, ItemID, MemberID, RecordID
FORM_INPUT_CANCELSubject, Message, RoomID, ItemID, MemberID, RecordID
FORM_INPUT_SAVESubject, Message, RoomID, ItemID, MemberID, RecordID
FORM_INPUT_CLOSESubject, Message, RoomID, ItemID, MemberID, RecordID
PAYMENT_METHOD_SUBMITRaised when a payment method is submitted.Subject, Message, RoomID, RecordID
CONFIGURATION_STARTRaised when a product configuration is initially requested.Subject, Message, RoomID, ItemID, MemberID, RecordID, ConfigurationID
CONFIGURATION_UPDATERaised when a product configuration is updated.Subject, Message, RoomID, ItemID, MemberID, RecordID, ConfigurationID
CONFIGURATION_SUBMITRaised when a product configuration is submitted.Subject, Message, RoomID, ItemID, MemberID, RecordID, ConfigurationID
BATCH_DOCUMENT_MERGERaised when a document batch completes.Subject, Message, RecordID, AttachmentID, ContentVersionID, ContentDocumentID, Origin (Batch Def ID)
BATCH_COMPLETERaised for each successfully merged document in a batch.Subject, Message, RecordID (Batch ID), Origin (Batch Def ID)
BATCH_DOCUMENT_SENTRaised when a document is emailed using the batch emailer.Subject, Message, RecordID, RecordType, AttachmentID, Origin (Batch Def ID)
BATCH_EMAILER_COMPLETERaised for each successfully merged document in a batch.Subject, Message, RecordID (Batch ID),Origin (Batch Def ID)
CONTENT_VERSION_TEXT_EXTRACT_COMPLETERaised when text extraction is complete for a ContentVersion (CV) record. Indicates the CV is ready for GPT completion and chat.Subject (extract JobId), RecordType (“ContentVersion”), Message (S3 key reference), RecordID (ContentVersion ID), ContentVersionID (ContentVersion ID), AttachmentID (parentID), Value (WordCount),Origin (“QUEUE”)