Skip to content

Glossary ​

Terms used across the Integration Framework documentation.

Partner ​

An external organisation that exchanges events with ChronosHub, for example a publisher or a service provider. Each partner has its own credentials and its own set of event types it may send and receive.

Event ​

A message describing something that happened, for example a manuscript was uploaded or an invoice was paid. Every event has an event type such as manuscript.uploaded.

Inbound ​

The direction from your system to ChronosHub. You send an inbound event with POST /inbound/{eventType}, authenticated with your API key. See Inbound Events.

Outbound ​

The direction from ChronosHub to your system. ChronosHub delivers an outbound event to your webhook as a signed HTTP POST. See Outbound Events.

Subscription ​

Your choice of which outbound event types ChronosHub delivers to your webhook. You only receive events for event types you are subscribed to.

Event contract ​

The agreed definition of an event type in one direction: the JSON Schema its payload must follow. ChronosHub validates events against it.

Version ​

An event contract can change over time. Each change is a new numbered version of the contract. Only one version is Active at a time; older ones may stay accepted as Deprecated.

Draft, Active, Deprecated, Retired ​

The lifecycle states of a contract version.

  • Draft — a version being prepared. It is not yet used to validate events.
  • Active — the current version. New integrations should target it.
  • Deprecated — a previous version that is still accepted so existing integrations keep working. Responses carry headers telling you to migrate. See Inbound Events.
  • Retired — no longer accepted.

Sandbox ​

A test-environment partner created by an invite. It lets an external developer try the integration end to end without a contract or any effect on production. Events a sandbox partner sends are validated and stored but not forwarded to ChronosHub services.

Invite ​

A one-time code from ChronosHub that lets you create a sandbox.

Readiness ​

A per-event-type pass/fail report showing whether your integration works end to end.