Overview

Subscribers must “subscribe” to a Program in order to pull its data from the Hub. The Publisher’s data are not publicly accessible to prevent it from being scraped, and to give Publishers controls over their data.

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

Data model

LbApiPayloadTemplate syntax and purpose

Publishers and Subscribers think about and model their data differently, so the publisher’s data typically needs modified or converted before it can be imported into LearningBuilder.

Each Event Subscription specifies:

• Which PublisherEventCategory values it cares about

• A Handlebars template that specifies how to convert Events of that category into a JSON format that can be imported through the Subscriber’s API/WorkflowImportQueue/CreateBatch API.

Those templates are stored in the LbApiPayloadTemplate property of an EventSubsription:

"LbApiPayloadTemplate": {
  "{EventCategory1}": {
    "action": "import (default) | ignore",
    "label": "human readable note",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }, 

  // ... additional category mappings as needed ...

  "_default": {
    "action": "import (default) | ignore",
    "label": "human readable note",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Each key within the LbApiPayloadTemplate should match one of the Publisher’s PublisherEventCategory values, or the special marker “_default” which indicates a default template.

There are two reasons to include a PublisherEventCategory mapping:

• To import it into the Subscriber, using the specified batchRowTemplate

• To ignore it, because the Subscriber isn’t interested in that category of publisher data

Syntax examples

"LbApiPayloadTemplate": {
  "_default": {
    "action": "import",
    "label": "Import everything",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

"LbApiPayloadTemplate": {
  "some_key": {
    "action": "import",
    "label": "ACME Course",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  },
  "_default": {
    "action": "import",
    "label": "Import everything",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

"LbApiPayloadTemplate": {
  "COURSE": {
    "action": "import",
    "label": "ACME course",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  },
  "_default": {
    "action": "ignore",
    "label": "Nothing else matters"
  }
}

"LbApiPayloadTemplate": {
  "SOME_CATEGORY": {
    "action": "ignore",
    "label": "ACME course"
  },
  "_default": {
    "action": "import",
    "importProcessId": {WIQ Process Id},
    "batchRowTemplate": "{handlebars template}"
  }
}

Detailed data flow

It works like this:

• When Publishers push data into the Hub, they specify a PublisherEventCategory value. (For example, this might differentiate between data representing a completed course and data representing work history)

• A Subscriber’s EventSubscription contain contain one or more templates, each one mapped to a specific PublisherEventCategory value. (This allows the subscriber to convert those courses and work history entries in different ways)

• Each template converts a single PublisherEventData JSON object into a different JSON schema that can be passed to the Subscriber’s API/WorkflowImportQueue/CreateBatch API endpoint.

• When LearningBuilder synchronizes data, it loops through each PublisherEventData item, converts it using the relevant template, and then makes a single call to API/WorkflowImportQueue/CreateBatch to import the data.

Event Subscriptions

GET /api/programs/{programId}/eventSubs

Responses

[
  { 
    "ProgramId": "subscriber_program_id", 
    "PublisherProgramId": "publisher_program_id", 
    "CreatedUtc": "UTC date/time",
    "LastSyncUtc": "UTC date/time",
    "SynEnabled": true,
    "LbApiPayloadTemplate": {
      "SOME_CATEGORY": {
        "action": "import",
        "label": "ACME Course",
        "importProcessId": {WIQ Process Id},
        "batchRowTemplate": "{handlebars template}"
      }
    }    
  },
  ...
]

GET /api/programs/{programId}/eventSubs/{publisherId}

Responses

{ 
  "ProgramId": "foo", 
  "PublisherProgramId": "bar", 
  "CreatedUtc": "UTC date/time",
  "LastSyncUtc": "UTC date/time",
  "SynEnabled": true,
  "LbApiPayloadTemplate": { see docs above }  
}

POST /api/programs/{programId}/eventSubs

JSON Payload

{
  "PublisherProgramId": "PublisherId",
  "SyncEnabled": true,
  "LbApiPayloadTemplate": {
    "SOME_CATEGORY": {
      "action": "import",
      "label": "ACME Course",
      "importProcessId": {WIQ Process Id},
      "batchRowTemplate": "{handlebars template}"
    }
  }    
}

Responses

PATCH /api/programs/{programId}/eventSubs/{publisherId}

JSON Payload

{
    "LastSyncUtc": "date",
    "SyncEnabled": true,
    "LbApiPayloadTemplate": { see docs above }  
}

Responses

DELETE /api/programs/{programId}/eventSubs/{publisherId}

Responses