Skip to main content

SyncHive Events

By defining events, subscribing to them, and connecting SyncHive to external apps, you can unlock powerful, event-driven use cases. Whether it’s sending alerts, updating dashboards, or launching business workflows, SyncHive ensures the right signals reach the right tools - instantly and reliably.

There are two types of events available in SyncHive: data exchange events and data sourced events.

Data exchange events track the flow of data between systems, capturing outcomes like successful syncs, failures, or network-related issues that occur as data moves across system boundaries.

Data sourced events track changes within the data itself, capturing when new data is created, modified, or removed in a connected system, independent of any particular sync operation.

One example is automating email notifications: when an error occurs in a specific integration, SyncHive detects it, sends the information to an external app, which delivers an email to your stakeholders.

Event consumption in SyncHive follows three steps:

  1. Define Events - define the circumstances under which an event will be raised.
  2. Subscribe to Events - Set up delivery of those events to external systems.
  3. Trigger External Actions - Let external systems carry out notifications, workflows, or downstream processes.

Step 1: Define Events​

Event Definitions let you decide which events should be available for consumption.

What is an Event Definition?​

An Event Definition is a set of rules that generates events according to conditions you set. These conditions can include error types, event codes, integrations, or shapes.

For example:

Condition = ERROR

Integration = Shopify

Shape = product

Status = ENABLED

This setup means that whenever a product shape related error occurs in an integration, SyncHive will recognize it as a matching event.

Step 2: Subscribe to Events​

Subscriptions act as the bridge between SyncHive and the external systems you rely on. By subscribing to an event, you turn it into a real-time trigger that delivers structured notifications directly to your chosen endpoint.

The Role of Subscriptions​

Each subscription defines a simple relationship: when an event occurs, SyncHive delivers a structured message to the endpoint you’ve configured. This message becomes the signal that your external system uses to act. You can create many subscriptions in parallel, each tailored to different events, endpoints, or use cases.

Subscription States:

  • Enabled – Delivering event payloads in real time.
  • Disabled – Temporarily paused, but not deleted.

This flexibility means you can adapt to changing needs without losing your setup.

Subscription Configuration​

When creating a subscription, you’ll configure:

  • Event name – A label to recognize the subscription.
  • Event source – The Event Definition that should act as the trigger.
  • Target – The endpoint URL where notifications are delivered.
  • Request Method – The HTTP method (e.g., POST, PUT).
  • Additional Controls – Options like requiring an API key, including message details, or attaching logs.
  • Status – enabled or disabled.
  • Preview – Sample payload to see exactly what the receiving system will get.

How Notifications Flow​

  1. An Event occurs.
  2. SyncHive evaluates enabled subscriptions.
  3. If a match is found, SyncHive sends a JSON payload to the subscribed endpoint.
  4. Multiple subscriptions can listen to the same event, each receiving its own payload.

The Preview feature helps you validate payloads before moving into production.

Inactive subscriptions are skipped, ensuring only active connections consume system events. The Preview feature helps you validate payloads before moving into production.

Practical Applications​

With subscriptions, you can:

  • Trigger an email notification when errors occur.
  • Record warnings in a monitoring dashboard.
  • Start downstream workflows in your automation platform whenever a key event is raised.

Step 3: Trigger External Actions​

Once subscriptions are in place, SyncHive hands over to your external systems. These systems turn incoming event payloads into meaningful outcomes like emails, alerts, or workflow executions.

Boundaries of Responsibility​

SyncHive is responsible for:

  • Correct evaluation of event definitions.
  • Delivery of event notifications to configured subscriptions.
  • Ensuring payload integrity and schema consistency.

External systems are responsible for:

  • Authenticating requests (e.g., validating API keys).
  • Executing the downstream action (e.g., sending an email).
  • Handling retries or errors if the endpoint cannot process the payload.

Payload Rules​

  • Content: Event metadata (event code, integration key, condition), optional messages/logs, subscription identifier.
  • Format: JSON
  • Preview: Example payloads can be reviewed inside SyncHive before production use.

To ensure smooth operations, we recommend:

  • Filtering – Use event metadata (code, status, integration) to refine triggers.
  • Security – Validate API keys if required by the subscription.
  • Error Handling – Implement retries or fallback logic in your automation platform.