(Classic) Event Protocol Best Practices

We have defined several common event protocols on top of EXP. If you are raising events on EXP that don't fit into one of those, you are welcome to define your own event hierarchy. The following are some best practices for doing that. 

  • An event hierarchy has two levels, the event domain and the event type.  Event domains and types use the characters \[A-Za-z0-9_]. 
  • You should pick an event domain that is unique to you and is unlikely conflict with other events being raised. If more than one party is involved in the events being raised or they are very general, then you are invited and encouraged to work with Kynetx to define a global event protocol. 
  • Define event types within that domain that describe state changes within your system that you would like developers to be able to respond to
  • For each event type, define the relevant event attributes. 

 

Copyright Picolabs | Licensed under Creative Commons.