Versions Compared

Old Version 3

changes.mady.by.user Seth Petry-Johnson

Saved on

compared with

New Version 4

changes.mady.by.user Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Heuristics staff establish these relationships partially to manage the complex templates that are required, but also to ensure that the Subscriber has a legitimate need to access that Publisher’s data.

API Hostnames

See https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3697770890/Learning+Hub#API-Hostnames

Authentication

See https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3697770890/Learning+Hub#Authentication

Note

Unless otherwise specified, all endpoints on this page require an API Key with SYSTEM permissions.

Data model

SUBSCRIPTION

A Subscription is a relationship from a Subscriber to a Publisher that allows the Subscriber to receive the Publisher’s data.

Field

Type

Notes

ProgramId

string (25 char)

The identifier of the Subscriber

PublisherProgramId

string (25 char)

The identifier of the Publisher

LastSyncUtc

UTC date/time

UTC timestamp of the last time the Subscriber pulled data from this Publisher

SyncEnabled

boolean

Whether or not the subscription supports the nightly sync process. (LB Applies to LearningBuilder subscribers only)

Note

Setting this to TRUE does not automatically enable the nightly sync, it just allows the nightly sync to process this subscription.

LbApiPayloadTemplate

string

JSON

JSON structure mapping different PublisherEventCategory values to the Handlebars template that will convert the Publisher’s EventData converts those Events into a batch row payload for LearningBuilder’s WorkflowImportQueue/CreateBatch API.

Calling the API

API Hostnames

See https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3697770890/Learning+Hub#API-Hostnames

Authentication

See https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3697770890/Learning+Hub#Authentication

...

Code Block
languagejson
{
  "{EventCategory}": {
    "label": "human readable note",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

See below for detailed explanation

Converting Provider data into Subscriber data

Publishers and Subscribers think about and model their data differently. Each Event Subscription contains one or more templates that convert from the Provider’s data model into the Subscriber’s data model.

Each template is mapped to a PublisherEventCategory value. The template is responsible for converting the PublisherEventData JSON, for that category value, into a BatchRowvalue that can be passed into API/WorkflowImportQueue/CreateBatch.

...

Event Subscriptions

Info

“Event Subscriptions” track which Programs will receive the Events published by other Programs.

...