.. _events:

The Envase Events
====================

When publishing events to Envase connect, the following event properties
are required:


-  Type: All the information about the event properties. This contains the project, type and action of the event.

-  Payload: Expected payload. The structure of each payload can be
   found: Envase Connect API Docs

The below example publishes a gate interchange event to Envase Connect from securspace

.. code:: json

   {
       "type": "securspace.gate.interchange",
       "payload": {
         // gate object here
       }
   }

A successful event publishing will return the contents of the event that was published. If the event was not successfully published, the system will return an error code with a small message about why it failed.

When an event is published, some properties may be added to the event by
Envase Connect. The original payload, however, is not changed.