Skip to main content

​
How to set up Nooks

​
Authentication

Nooks uses API key authentication:
  1. In Nooks, open Developer Settings → API Keys
  2. Generate a key (it starts with nooks-api-)
  3. Paste the API key in Cargo when connecting
API keys have full read and write access to the Nooks workspace they were created in.
Code slugs: integration slug nooks. Actions: enrollInSequence, removeFromSequence, syncProspect, getProspect, createTask, createNote. Call them as integrations.nooks.<action>(...).

​
Finding the prospect

Every action that targets a prospect accepts any of:
  • Nooks prospect ID: used as is when set
  • Email: matched against the prospect’s primary email
  • CRM record ID + CRM: a Salesforce Contact/Lead ID or a HubSpot contact ID
Nooks prospects come from your CRM. When a CRM record has no Nooks prospect yet, Enroll in sequence, Create task and Create note sync it from the CRM first. Get prospect and Remove from sequence only look it up.

​
Nooks actions

​
Enroll in sequence

Enroll a prospect in a sequence. Required fields:
  • Sequence: The sequence to enroll the prospect in
  • Owner: The Nooks user who owns the enrollment
  • A prospect reference (see above)
Optional fields:
  • Mailbox: Mailbox the emails go out from (defaults to the owner’s)
  • Initial state: Active or paused
  • Start at: When the sequence starts (ISO 8601 with a timezone offset)
  • Email overrides: A per-step subject and body for this prospect
  • Enrich phone numbers / Enrich emails: Ask Nooks to enrich the prospect on enrollment
A prospect who is already enrolled is reported as Already enrolled rather than failing the run. Use case: Push qualified leads into the right sequence with AI-written first emails.

​
Remove from sequence

Stop a prospect’s enrollment in a sequence and cancel its pending tasks. Required fields:
  • Sequence: The sequence to take the prospect out of
  • A prospect reference

​
Sync prospect from CRM

Create or refresh a Nooks prospect from a Salesforce or HubSpot record. Required fields:
  • CRM: Salesforce or HubSpot
  • CRM record ID: The record to sync

​
Get prospect

Find a Nooks prospect by ID, primary email, or CRM record ID. Optional fields:
  • Include CRM custom fields: Return the prospect’s CRM custom fields

​
Create task

Create a one-off task (call, email, LinkedIn, SMS) for a prospect, outside any sequence. Required fields:
  • Type: The kind of task
  • Owner: The Nooks user the task is assigned to
  • Due at: ISO 8601 with a timezone offset
  • A prospect reference
Optional fields:
  • Note: Instructions shown on the task
  • Priority: Low, normal, high, or urgent

​
Create note

Log a note on a CRM-backed prospect. Nooks writes it to the Salesforce or HubSpot record. Required fields:
  • Note: The note text
  • A prospect reference, with CRM set to the CRM the prospect comes from

​
Best practices

  • Nooks limits CRM syncs to 10 a minute. Cargo looks a prospect up before syncing it, so large batches stay fast once your prospects exist in Nooks.
  • Enroll into a private sequence only on behalf of its owner.