Skip to main content

Knock

Subsets supports syncing data to Knock using two APIs:

  • Data API (https://api.knock.app/v1/) — Bulk identify users /users/bulk/identify for writing experiment data onto user profiles
  • Management API (https://control.knock.app/v1/) — Workflow, Broadcast, and Guide endpoints for reading message/campaign details

The following custom properties are set on each user profile in Knock:

{
'subsets_experiment_id',
'subsets_experiment_added_at',
'subsets_experiment_name',
'subsets_subscriber_churn_risk',
'subsets_experiment_assignment',
'experiment_external_id'
}

Campaign linking

Knock messages come in three types. When linking an experiment you select the type, enter its key, and Subsets reads the details from the matching Management API endpoint:

TypeEndpoint
Workflowworkflows/{key}
Broadcastbroadcasts/{key}
Guideguides/{key}

Setup guide

  1. In the Knock dashboard, create a secret API key (Settings → API keys) for user export.
  2. Create a Service Token for reading workflows, broadcasts, and guides.
  3. Share both with us.

Required credentials

CredentialDescription
API KeyKnock secret API key — Bearer auth for the Data API (user export)
Service TokenKnock service token — Bearer auth for the Management API