Events

An event is the common REGOS notification object. Events have an event_id, an action, an occurrence time, and a business payload in data.

Persistent events are stored temporarily and can be restored with Event/Get. Transient events are available only during delivery and are not returned by Event/Get.

Event Catalog

Action Persistence Payload fields
PromoBonusPaymentPerformed Persistent uuid, value
PromoBonusEnrollmentPerformed Persistent uuid, value
PromoBonusPaymentCanceled Persistent uuid, value
PromoBonusManualIncomeOperationCreated Persistent uuid, value
PromoBonusManualOutcomeOperationCreated Persistent uuid, value
DocSessionOpened Persistent uuid
DocSessionClosed Persistent uuid
DocChequeClosed Persistent uuid
DocChequeCanceled Persistent uuid
POSChequePayDebt Persistent uuid
DocOrderDeliveryAdded Persistent id
DocOrderDeliveryEdited Persistent id
DocOrderDeliveryDeleted Persistent id
DocOrderDeliveryPerformed Persistent id
DocOrderDeliveryPerformCanceled Persistent id
DocOrderDeliveryStatusSet Persistent id, status
DocOrderDeliveryStockSet Persistent id, stock_id
DocOrderDeliveryCourierSet Persistent courier_id, id
DocOrderDeliveryReturned Persistent id
DocOrderDeliveryActualized Persistent id
DocOrderDeliveryDeleteMarked Persistent id
DocOrderDeliveryFiscalInfoSet Persistent id
DocOrderDeliveryResetToBeginning Persistent id
DocWholeSaleAdded Persistent id
DocWholeSaleEdited Persistent id
DocWholeSaleDeleteMarked Persistent id
DocWholeSaleDeleted Persistent id
DocWholeSalePerformed Persistent id
DocWholeSalePerformCanceled Persistent id
DocWholeSaleReturnAdded Persistent id
DocWholeSaleReturnEdited Persistent id
DocWholeSaleReturnDeleteMarked Persistent id
DocWholeSaleReturnDeleted Persistent id
DocWholeSaleReturnPerformed Persistent id
DocWholeSaleReturnPerformCanceled Persistent id
DocOrderFromPartnerAdded Persistent id
DocOrderFromPartnerEdited Persistent id
DocOrderFromPartnerDeleteMarked Persistent id
DocOrderFromPartnerDeleted Persistent id
DocOrderToMovementAdded Persistent id
DocOrderToMovementEdited Persistent id
DocOrderToMovementDeleteMarked Persistent id
DocOrderToMovementDeleted Persistent id
DocOrderToPartnerAdded Persistent id
DocOrderToPartnerEdited Persistent id
DocOrderToPartnerDeleteMarked Persistent id
DocOrderToPartnerDeleted Persistent id
DocPurchaseAdded Persistent id
DocPurchaseEdited Persistent id
DocPurchaseDeleteMarked Persistent id
DocPurchaseDeleted Persistent id
DocPurchasePerformed Persistent id
DocPurchasePerformCanceled Persistent id
DocReturnsToPartnerAdded Persistent id
DocReturnsToPartnerEdited Persistent id
DocReturnsToPartnerDeleteMarked Persistent id
DocReturnsToPartnerDeleted Persistent id
DocReturnsToPartnerPerformed Persistent id
DocReturnsToPartnerPerformCanceled Persistent id
DocMovementAdded Persistent id
DocMovementEdited Persistent id
DocMovementDeleteMarked Persistent id
DocMovementDeleted Persistent id
DocMovementPerformed Persistent id
DocMovementPerformCanceled Persistent id
DocInventoryAdded Persistent id
DocInventoryEdited Persistent id
DocInventoryDeleteMarked Persistent id
DocInventoryDeleted Persistent id
DocInventoryClosed Persistent id
DocInventoryOpened Persistent id
DocInOutAdded Persistent id
DocInOutEdited Persistent id
DocInOutDeleteMarked Persistent id
DocInOutDeleted Persistent id
DocInOutPerformed Persistent id
DocInOutPerformCanceled Persistent id
CampaignAdded Persistent id
CampaignRecipientsStatusSet Persistent id
CampaignDeleted Persistent id
SMSAdded Persistent id
SMSStatusSet Persistent id
DocPaymentAdded Persistent id
DocPaymentEdited Persistent id
DocPaymentDeleteMarked Persistent id
DocPaymentDeleted Persistent id
DocPaymentPerformed Persistent id
DocPaymentPerformCanceled Persistent id
RetailCustomerAdded Persistent id
RetailCustomerEdited Persistent id
RetailCustomerDeleteMarked Persistent id
RetailCustomerDeleted Persistent id
RetailCardAdded Persistent id
RetailCardEdited Persistent id
RetailCardDeleted Persistent id
PartnerAdded Persistent id
PartnerEdited Persistent id
PartnerDeleteMarked Persistent id
PartnerDeleted Persistent id
ItemAdded Persistent id
ItemEdited Persistent id
ItemDeleteMarked Persistent id
ItemDeleted Persistent id
DocAccountMovementAdded Persistent id
DocAccountMovementEdited Persistent id
DocAccountMovementDeleteMarked Persistent id
DocAccountMovementDeleted Persistent id
DocAccountMovementPerformed Persistent id
DocAccountMovementPerformCanceled Persistent id
UserAdded Persistent id
UserAddedGlobal Persistent id
UserEdited Persistent id
UserDeleted Persistent id
ItemGroupAdded Persistent id
ItemGroupEdited Persistent id
ItemGroupDeleted Persistent id
DepartmentAdded Persistent id
DepartmentEdited Persistent id
DepartmentDeleted Persistent id
UnitAdded Persistent id
UnitEdited Persistent id
UnitDeleted Persistent id
SizeChartAdded Persistent id
SizeChartEdited Persistent id
SizeChartDeleted Persistent id
ColorAdded Persistent id
ColorEdited Persistent id
ColorDeleted Persistent id
BrandAdded Persistent id
BrandEdited Persistent id
BrandDeleted Persistent id
ProducerAdded Persistent id
ProducerEdited Persistent id
ProducerDeleted Persistent id
CountryAdded Persistent id
CountryEdited Persistent id
CountryDeleted Persistent id
PartnerGroupAdded Persistent id
PartnerGroupEdited Persistent id
PartnerGroupDeleted Persistent id
RetailCustomerGroupAdded Persistent id
RetailCustomerGroupEdited Persistent id
RetailCustomerGroupDeleted Persistent id
RetailReturnReasonAdded Persistent id
RetailReturnReasonEdited Persistent id
RetailReturnReasonDeleted Persistent id
DeliveryFromAdded Persistent id
DeliveryFromEdited Persistent id
DeliveryFromDeleted Persistent id
DeliveryTypeAdded Persistent id
DeliveryTypeEdited Persistent id
DeliveryTypeDeleted Persistent id
DeliveryCourierAdded Persistent id
DeliveryCourierEdited Persistent id
DeliveryCourierDeleted Persistent id
PriceTypeAdded Persistent id
PriceTypeEdited Persistent id
PriceTypeDeleted Persistent id
PaymentTypeAdded Persistent id
PaymentTypeEdited Persistent id
PaymentTypeDeleted Persistent id
AccountOperationCategoryAdded Persistent id
AccountOperationCategoryEdited Persistent id
AccountOperationCategoryDeleted Persistent id
AccountAdded Persistent id
AccountEdited Persistent id
AccountDeleted Persistent id
CurrencyAdded Persistent id
CurrencyEdited Persistent id
CurrencyDeleted Persistent id
CurrencyExchangeRateEdited Persistent id
TaxVatAdded Persistent id
TaxVatEdited Persistent id
TaxVatDeleted Persistent id
RegionAdded Persistent id
RegionEdited Persistent id
RegionDeleted Persistent id
DocContractAdded Persistent id
DocContractEdited Persistent id
DocContractDeleteMarked Persistent id
DocContractDeleted Persistent id
DocPeriodClosingAdded Persistent id
DocPeriodClosingEdited Persistent id
DocPeriodClosingDeleted Persistent id
DocPeriodClosingCanceled Persistent id
DocSetPriceAdded Persistent id
DocSetPriceEdited Persistent id
DocSetPriceDeleteMarked Persistent id
DocSetPriceDeleted Persistent id
DocSetPricePerformed Persistent id
DocSetPricePerformCanceled Persistent id
DocInvoiceAdded Persistent id, invoice_type
DocInvoiceEdited Persistent id
DocInvoiceDeleteMarked Persistent id
DocInvoiceDeleted Persistent id
DocInvoicePerformed Persistent id
DocInvoicePerformCanceled Persistent id
DocTechMapAdded Persistent id
DocTechMapEdited Persistent id
DocTechMapDeleted Persistent id
DocTechMapPerformed Persistent id
DocTechMapPerformCanceled Persistent id
DocProductionAdded Persistent id
DocProductionEdited Persistent id
DocProductionDeleted Persistent id
DocProductionPerformed Persistent id
DocProductionPerformCanceled Persistent id
FirmGroupAdded Persistent id
FirmGroupEdited Persistent id
FirmGroupDeleted Persistent id
FirmAdded Persistent id
FirmEdited Persistent id
FirmDeleteMarked Persistent id
FirmDeleted Persistent id
StockAdded Persistent id
StockEdited Persistent id
StockDeleteMarked Persistent id
StockDeleted Persistent id
CashServerAdded Persistent id
CashServerEdited Persistent id
CashServerDeleted Persistent id
CashServerSyncBegun Persistent id
CashServerSyncEnded Persistent id
OperatingCashAdded Persistent id
OperatingCashEdited Persistent id
OperatingCashDeleted Persistent id
TargetAdded Persistent id
TargetDeleted Persistent id
TargetFinished Persistent id
DocOpeningBalanceAdded Persistent id
DocOpeningBalanceEdited Persistent id
DocOpeningBalanceDeleteMarked Persistent id
DocOpeningBalanceDeleted Persistent id
DocOpeningBalancePerformed Persistent id
DocOpeningBalancePerformCanceled Persistent id
ProjectAdded Persistent id
ProjectEdited Persistent id
ProjectDeleted Persistent id
ProjectTaskAdded Persistent chat_id, id
ProjectTaskEdited Persistent id
ProjectTaskDeleted Persistent id
ProjectTaskStatusSet Persistent id, status
ProjectTaskResponsibleSet Persistent id
ChatAdded Persistent id
ChatEdited Persistent id
ChatParticipantsSet Persistent id
ChatParticipantsRemoved Persistent id
ChatMessageAdded Persistent chat_id, id
ChatMessageEdited Persistent chat_id, id
ChatMessageDeleted Persistent chat_id, id
ChatMessageRead Persistent chat_id
ChatWriting Transient author_entity_id, author_entity_type, chat_id
ChannelAdded Persistent id
ChannelEdited Persistent id
ChannelDeleted Persistent id
LeadAdded Persistent id
LeadEdited Persistent id
LeadStageSet Persistent id
LeadResponsibleSet Persistent id
LeadConverted Persistent deal_chat_id, deal_id, lead_chat_id, lead_id, status
LeadClosed Persistent id, status
DealAdded Persistent id
DealEdited Persistent id
DealStageSet Persistent id
DealResponsibleSet Persistent id
DealClosed Persistent id
UserCheckedIn Persistent session_id, user_id
UserCheckedOut Persistent session_id, user_id
UserBreakStarted Persistent break_id, session_id, user_id
UserBreakEnded Persistent break_id, session_id, user_id
UserAvailabilityChanged Persistent is_checked_in, is_in_shift, is_on_break, status, user_id
LeadParticipantsSet Persistent id
DealParticipantsSet Persistent id
ChatSuggest Transient author_entity_id, author_entity_type, chat_id, source_message_id, suggestions
ChatMessagePinnedSet Persistent chat_id, id, pinned, user_id
ChatMessageReactionsSet Persistent chat_id, id, old_reactions, reactions, user_id
TicketAdded Persistent id
TicketEdited Persistent id
TicketResponsibleSet Persistent id
TicketParticipantsSet Persistent id
TicketClosed Persistent id, status
ReportPrepared Persistent uuid
ReportError Persistent uuid
TicketStatusSet Persistent id, old_status, status
TicketSlaBreached Persistent id, metric, sla_breached, sla_breached_date
TicketRatingSet Persistent id, rating
StorageCleanupProcessed Persistent error_files, processed_files, total_files
ClientAdded Persistent id
ClientEdited Persistent id
ClientDeleted Persistent id
ClientResponsibleSet Persistent id
ClientMerged Persistent source_client_id, target_client_id
ChatMutedSet Persistent id, muted, user_id
ChatArchivedSet Persistent archived, id, user_id
ChatPinnedSet Persistent id, pinned, user_id
ChatMessageCallback Persistent id
TicketClientSentimentSet Persistent client_id, id, sentiment_date, sentiment_score, sentiment_user_id