Skip to main content

Event Stream Distributor

Event Stream Distributor (ESD) delivers signageOS platform events (device pairing, provisioning recipes, telemetry, connection changes) to your own HTTPS endpoint as they happen. You configure an exporter that subscribes to the event types you care about and forwards each one to your webhook, so you can react to platform activity in your own systems without polling the REST API.

You can set an exporter up two ways:

  1. Set up in Box (the UI).
  2. Set up via REST API.

Core concepts​

  • Exporter: a configuration owned by an organization that forwards events to one webhook. It has a name, an optional description, the list of event types it is subscribed to, and an enabled flag.
  • Webhook: the HTTPS url that receives the events, plus a signing secret used to sign every delivery so you can verify it came from signageOS.
  • Subscribed event types: the specific events the exporter forwards (see below). An exporter delivers only the types you select.
  • Enabled: an exporter starts disabled. It begins delivering only once you enable it, and you can disable it at any time without deleting it.
  • Observability: each exporter tracks cumulative counters (delivered messages, retries, errors), the time of the last successful delivery, and a list of the most recent failures, so you can see whether delivery is healthy.

Events you can subscribe to​

An exporter delivers only the event types you select. Each type links to its payload reference in the Event catalogue.

Event typeEmitted when
Device.Verification.DevicePairedA device is paired to the organization
Device.Verification.DeviceUnpairedA device is unpaired
Device.ProvisioningRecipeCreatedA provisioning recipe is created
Device.ProvisioningRecipeUpdatedA provisioning recipe is updated
Device.ProvisioningRecipeDeletedA provisioning recipe is deleted
Device.ProvisioningRecipeStatusUpdatedA provisioning recipe status changes
Device.Telemetry.DeviceTelemetryRecordUpdatedA device telemetry record is updated
Device.DeviceConnectionAddedA device connection goes online
Device.DeviceConnectionDeletedA device connection goes offline

Webhook delivery​

Events are delivered as signed HTTP POST requests. The delivery body, the X-SOS-* headers, and the signature are documented once in the Event catalogue; the Set up via REST API guide walks through receiving a delivery and verifying its signature.

Next steps​