Skip to main content

Integration overview

Pollinator integrates with other systems through four published surfaces. None of them is specific to one product: every integrated platform, intranet or script uses the same ones.

You want to...UseSet up by
Send people from your platform into a Pollinator activity, and learn how they didThe integration contract: a signed launch token in, outcome events backA workspace owner or admin registers your platform
Read activities, start and drive sessions, read results and exports from a scriptThe REST API with a workspace API keyA workspace owner mints the key
Be told when something happensWebhooks, signed with HMAC-SHA256A workspace owner registers the endpoint
Put a session's participant view inside your own pageEmbedding by join codeThe deployment's operator allows your page's origin

Principles that hold across all of them​

  • The workspace comes from the credential. An API key, an integration and a webhook each belong to exactly one workspace, and no request can name a different one.
  • Privacy rules apply unchanged. A script or an integration gets exactly what a person in the console would get, and anonymous sessions stay anonymous through every surface. An outcome naming a learner is only ever produced for an identified session.
  • The server decides. Integrations send identities and receive outcomes; they never send a score or a verdict.
  • Credentials are shown once. API key secrets, webhook signing secrets and integration signing secrets are returned at creation (or rotation) and never again. Pollinator stores them hashed or encrypted.
  • No product-specific code paths. Pollinator treats every conforming client identically. Pamba is described as a worked example, not a special case.

Where to start​