Skip to main content

SyncHive Apps

A SyncHive App is an application that utilizes SyncHive integration capabilities via APIs to work with shape-based data. Once registered, the app can send data into SyncHive and read data back out through the Unified Data Store.

Registering a New App​

  1. Open SyncHive Apps
  2. Click Register App
  3. Enter the app details:
    • Name
    • Shapes it integrates with
    • Status: enabled or disabled
  4. Confirm registration

Once saved, SyncHive will generate credentials for the app and display the connection details:

  • The address to connect to
  • A secure app key
  • Instructions on how data is sent (request format, for example: JSON)

Viewing and Editing Registered Apps​

The SyncHive Apps main page displays a list of all apps registered within your SyncHive instance.

For each app, you can see:

  • App name
  • Shapes it connects to
  • Current status

From this page, you can:

  • View the app’s connection details
  • Edit the app’s registration information
  • Change the app’s status
  • Delete the app’s connection

API Overview​

Using this API, an external app can:

  • List records for a given shape with optional pagination and filtering
  • Retrieve a single record by its HiveID

All API access is authenticated using an app-specific API key generated during app registration.