capabilities.work

Tenant Onboarding and Notify

A 3-step recipe with Knock. We can help you get access.

Recipe · 3 steps

Tenant Onboarding and Notify

with Knock · Tenant Provisioning & Lifecycle
Works with AI assistants

Upsert a tenant, identify a member, and trigger a tenant-scoped workflow.

  1. Create or update the tenant with the supplied name and settings, merging with any existing tenant properties.
  2. Upsert the member user so the tenant-scoped workflow has a valid recipient.
  3. Trigger the workflow for the member scoped to the tenant so tenant-level overrides apply and the resulting messages are tagged with the tenant.
What you'll need to have ready
  • apiKey: Knock secret API key (sk_...) used as a Bearer token.
  • tenantId: The unique identifier for the tenant.
  • tenantName: An optional display name for the tenant.
  • settings: Optional tenant settings such as branding overrides.
  • userId: The unique identifier of the member user to identify.
  • email: The primary email address to set on the user.
  • workflowKey: The key of the workflow to trigger for the user.
  • data: Optional data payload passed into the workflow run.
For your developer

Arazzo workflow knock-app:tenant-onboarding-notify, 3 operations: setTenant → identifyUser → {$sourceDescriptions.workflowsApi.url}#/paths/~1v1~1workflows~1{key}~1trigger/post. Specs on APIs.io.

More recipes with Knock

Bulk Identify Users and NotifyBulk Set Objects and NotifyBulk Set Tenants and VerifyCancellable Workflow TriggerIdentify User, Set Preferences, and TriggerMerge Users and Re-notifySet Object Preferences and Audit MessagesSet Object, Add Subscriptions, and NotifyRegister Push Token and Read FeedSchedule a Recurring