FarEarth event output configuration
Background
Event output: FarEarth allows developers to simplify API integration through the use of event outputs. Event outputs enable asynchronous notifications that avoid expensive periodic polling typically encountered when using REST APIs.
The event outputs are expressed as one or more configuration files that tie the two following concepts together:
- One or more event sources: which FarEarth events should be included; and
- Exactly one event output type: where the event(s) will be sent
Configuration
See How to add new events for instructions on how to add new Events.
Event sources
We currently support order completed events. You will receive a notification when an order has completed.
Event Output types
Event outputs are set via the outputProperties object. See below for available options: