Connect AI agents to Nooks

Scalekit connector

The Nooks connector lets your AI agent act in each user's Nooks account. Each user signs in to Nooks once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 20 tools.

Tools: 20
What they doRead · write · destructive: 16 · 4 · 016 read4 write0 destructive
Users sign in with: OAuth
OAuth app: Your own Nooks app

Setup

npm install @scalekit-sdk/node dotenv

pip install scalekit-sdk-python python-dotenv

Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Nooks connection
In AgentKit > Connections, create a Nooks connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

Register an OAuth app

Nooks connections use your own OAuth app. Register one with Nooks and add the redirect URI you copied.

Then enter the app's Client ID and Client Secret on the Nooks connection.

Console steps with screenshots

Each user signs in with their own Nooks account through OAuth 2.0. You set up one OAuth client from Nooks on your Scalekit connection. Scalekit then refreshes each user’s one-hour Nooks access token for you.

Create a connection in Scalekit
- In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Nooks and click Create.
- Copy the Redirect URI. It looks like: https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback
Keep this tab open — you’ll return to it in step 3.

Get OAuth client credentials from Nooks

Ask your Nooks account team or Nooks support for an OAuth client for the Nooks API, and send them:

the Redirect URI you copied from Scalekit
the scopes your agent needs, from the table below

Scope	Required for
`users:read`	Current user and user lookups (required)
`sequences:read`	Listing and reading sequences
`sequence-states:read`	Listing sequence enrollments
`sequence-states:write`	Enrolling prospects in sequences
`prospects:read`	Listing and reading prospects
`notes:write`	Creating CRM notes on prospects
`accounts:read`	Listing and reading accounts
`calls:read`	Listing and reading calls
`call-dispositions:read`	Listing call dispositions
`emails:read`	Listing and reading emails
`tasks:read`	Listing and reading tasks
`tasks:write`	Creating and completing tasks

Nooks returns a Client ID and Client Secret. Store the secret securely.

Add credentials in Scalekit
- Return to Scalekit dashboard → AgentKit > Connections and open the connection you created in step 1.
- Enter the following:
  - Client ID — from Nooks
  - Client Secret — from Nooks
  - Permissions — the same scopes Nooks enabled for your client
- Click Save.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'nooks'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Nooks:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'nooks_accounts_list',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "nooks"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Nooks:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="nooks_accounts_list",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

nooks_account_getGet one Nooks account (company) by its ID.Read-only
Get Account
Get one Nooks account (company) by its ID. Returns the account's name, domain, CRM IDs, owner, and optionally its CRM custom fields. Use nooks_account_get when you have the ID. Use nooks_accounts_list to search by name, domain, or CRM ID.
Inputs
idstringrequired
Nooks ID (UUID) of the account. Get it from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
include_crm_custom_fieldsboolean
Set to true to add each record's CRM custom fields as crmCustomFields, keyed by CRM field name (for example {"hs_lead_status": "OPEN"}).
nooks_accounts_listList CRM-sourced accounts (companies) in Nooks, filtered by IDs, exact name, domain, CRM ID, or update time.Read-only
List Accounts
List CRM-sourced accounts (companies) in Nooks, filtered by IDs, exact name, domain, CRM ID, or update time. Returns up to 100 accounts per page with name, domain, CRM IDs, and owner, plus a links.next cursor. Use nooks_accounts_list to find an account. Use nooks_account_get when you already have the account ID.
Inputs
filter_crm_idstring
Only return the account with this ID in your CRM. Example: 0015g00000XyZabAAB.
filter_domainstring
Only return the account with this exact domain. Example: acme.com.
filter_idsstring
Only return accounts with these Nooks IDs, comma-separated. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
filter_namestring
Only return the account with this exact name. Example: Acme Inc.
include_crm_custom_fieldsboolean
Set to true to add each record's CRM custom fields as crmCustomFields, keyed by CRM field name (for example {"hs_lead_status": "OPEN"}).
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of accounts to return per page (1 to 100). Defaults to 50.
updated_afterstring
Only return accounts updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return accounts updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_call_dispositions_listList the call dispositions (call outcomes) configured in the Nooks workspace.Read-only
List Call Dispositions
List the call dispositions (call outcomes) configured in the Nooks workspace. Returns up to 100 dispositions per page with id and name, plus a links.next cursor. Use nooks_call_dispositions_list to get disposition IDs for filtering nooks_calls_list.
Inputs
filter_namestring
Only return the disposition with this exact name. Example: Meeting Booked.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of dispositions to return per page (1 to 100). Defaults to 50.
nooks_call_getGet one Nooks call by its ID.Read-only
Get Call
Get one Nooks call by its ID. Returns the call's time, duration, direction, disposition, notes, prospect, and owner, optionally with those related records embedded. Use nooks_call_get when you have the call ID. Use nooks_calls_list to find calls.
Inputs
idstringrequired
Nooks ID (UUID) of the call. Get it from nooks_calls_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: prospect, sequence, sequenceStep, callDisposition, owner. Example: prospect,sequence.
nooks_calls_listList calls made in Nooks, filtered by call time, ingestion time, prospect, account, disposition, or caller.Read-only
List Calls
List calls made in Nooks, filtered by call time, ingestion time, prospect, account, disposition, or caller. Returns up to 100 calls per page with time, duration, direction, disposition, prospect, and owner, plus a links.next cursor. Use nooks_calls_list to find calls. Use nooks_call_get for one call by ID.
Inputs
account_idstring
Only return calls linked to this account. Use the account's Nooks ID (UUID) from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
created_afterstring
Only return calls ingested into Nooks at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
created_beforestring
Only return calls ingested into Nooks at or before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
disposition_idstring
Only return calls logged with this disposition. Use the disposition's Nooks ID (UUID) from nooks_call_dispositions_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
filter_idsstring
Only return calls with these Nooks IDs, comma-separated. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: prospect, sequence, sequenceStep, callDisposition, owner. Example: prospect,sequence.
owner_idstring
Only return calls placed by this user. Use the user's Nooks ID from nooks_users_list or nooks_me_get. Example: Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of calls to return per page (1 to 100). Defaults to 50.
prospect_idstring
Only return calls with this prospect. Use the prospect's Nooks ID (UUID) from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
time_afterstring
Only return calls that happened at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
time_beforestring
Only return calls that happened at or before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
updated_afterstring
Only return calls updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return calls updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_email_getGet one Nooks email by its ID, including unsent drafts and queued sends.Read-only
Get Email
Get one Nooks email by its ID, including unsent drafts and queued sends. Returns the email's subject, body, status, recipients, and related prospect, task, and sequence. Use nooks_email_get when you have the email ID. Use nooks_emails_list to find sent emails.
Inputs
idstringrequired
Nooks ID (UUID) of the email. Get it from nooks_emails_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: prospect, task, sequence, sequenceStep. Example: prospect,task.
nooks_emails_listList sent and in-flight emails in Nooks, filtered by IDs, prospect, task, account, status, or update time.Read-only
List Emails
List sent and in-flight emails in Nooks, filtered by IDs, prospect, task, account, status, or update time. Returns up to 100 emails per page with subject, status, recipients, and related prospect and sequence, plus a links.next cursor. Unsent drafts are not listed. Use nooks_emails_list to review outreach. Use nooks_email_get for one email, including drafts.
Inputs
account_idstring
Only return emails to prospects at this account. Use the account's Nooks ID (UUID) from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
filter_idsstring
Only return emails with these Nooks IDs, comma-separated. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: prospect, task, sequence, sequenceStep. Example: prospect,task.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of emails to return per page (1 to 100). Defaults to 50.
prospect_idstring
Only return emails to this prospect. Use the prospect's Nooks ID (UUID) from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
statusstring
Only return emails with these delivery statuses. Pass one or more of these values, comma-separated: draft, in_progress, sent, failed. Example: sent.
task_idstring
Only return emails sent for this sequence task. Use the task's Nooks ID (UUID) from nooks_tasks_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
updated_afterstring
Only return emails updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return emails updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_me_getGet the Nooks workspace and user behind the current credential.Read-only
Get Current User
Get the Nooks workspace and user behind the current credential. Returns workspaceId, userId, email, name, and, for OAuth tokens, the client ID and granted scopes. Use nooks_me_get to check the connection and to get your own user ID for owner fields.
Inputs
This tool takes no inputs.
nooks_prospect_getGet one Nooks prospect by its ID.Read-only
Get Prospect
Get one Nooks prospect by its ID. Returns the prospect's name, title, emails, phones, account reference, owner, and optionally its enrollments and CRM custom fields. Use nooks_prospect_get when you have the ID. Use nooks_prospects_list to search by email, name, or CRM ID.
Inputs
idstringrequired
Nooks ID (UUID) of the prospect. Get it from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: sequenceStates. Example: sequenceStates.
include_crm_custom_fieldsboolean
Set to true to add each record's CRM custom fields as crmCustomFields, keyed by CRM field name (for example {"hs_lead_status": "OPEN"}).
nooks_prospects_listList prospects in Nooks, filtered by IDs, exact name or title, email, CRM ID, sequence, account, or update time.Read-only
List Prospects
List prospects in Nooks, filtered by IDs, exact name or title, email, CRM ID, sequence, account, or update time. Returns up to 100 prospects per page with contact details, account reference, and owner, plus a links.next cursor. Use nooks_prospects_list to find prospects. Use nooks_prospect_get when you already have the prospect ID.
Inputs
account_idstring
Only return prospects at this account. Use the account's Nooks ID (UUID) from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
filter_crm_idstring
Only return the prospect with this ID in your CRM. Example: 0035g00000XyZabAAB.
filter_emailsstring
Only return prospects whose primary email is one of these addresses, comma-separated (up to 10). Example: jane@acme.com,john@acme.com.
filter_idsstring
Only return prospects with these Nooks IDs, comma-separated. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
filter_namestring
Only return prospects with this exact full name. Example: Jane Doe.
filter_titlestring
Only return prospects with this exact job title. Example: VP of Sales.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: sequenceStates. Example: sequenceStates.
include_crm_custom_fieldsboolean
Set to true to add each record's CRM custom fields as crmCustomFields, keyed by CRM field name (for example {"hs_lead_status": "OPEN"}).
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of prospects to return per page (1 to 100). Defaults to 50.
sequence_idstring
Only return prospects enrolled in this sequence. Use the sequence's Nooks ID (UUID) from nooks_sequences_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
updated_afterstring
Only return prospects updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return prospects updated at or before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_sequence_getGet one Nooks sequence by its ID.Read-only
Get Sequence
Get one Nooks sequence by its ID. Returns the sequence's name, type, privacy, and owner, and optionally its owner record and steps. Use nooks_sequence_get to inspect a sequence before enrolling prospects. Use nooks_sequences_list to find one.
Inputs
idstringrequired
Nooks ID (UUID) of the sequence. Get it from nooks_sequences_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: owner, sequenceSteps. Example: owner,sequenceSteps.
nooks_sequence_states_listList sequence enrollments (sequence states) in Nooks, filtered by sequence, prospect, account, or state.Read-only
List Sequence Enrollments
List sequence enrollments (sequence states) in Nooks, filtered by sequence, prospect, account, or state. Returns up to 100 enrollments per page with state, current step, sequence, and prospect, plus a links.next cursor. Use nooks_sequence_states_list to see who is enrolled where. Use nooks_sequence_state_create to enroll a prospect.
Inputs
account_idstring
Only return enrollments of prospects at this account. Use the account's Nooks ID (UUID) from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: sequence, prospect, creator, sequenceStep. Example: sequence,prospect.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of enrollments to return per page (1 to 100). Defaults to 50.
prospect_idstring
Only return enrollments of this prospect. Use the prospect's Nooks ID (UUID) from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
sequence_idstring
Only return enrollments in this sequence. Use the sequence's Nooks ID (UUID) from nooks_sequences_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
statestring
Only return enrollments in these states. Pass one or more of these values, comma-separated: active, paused, finished, pending_start. Example: active,paused.
updated_afterstring
Only return enrollments updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return enrollments updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_sequences_listList outreach sequences in Nooks, optionally filtered by exact name, type, or last-updated time.Read-only
List Sequences
List outreach sequences in Nooks, optionally filtered by exact name, type, or last-updated time. Returns up to 100 sequences per page with id, name, type, privacy, and owner, plus a links.next cursor. Use nooks_sequences_list to find a sequence ID. Use nooks_sequence_get for one sequence and its steps.
Inputs
filter_namestring
Only return the sequence with this exact name. Example: Q3 Outbound.
filter_typestring
Only return sequences of this type: date (steps run on fixed dates) or interval (steps run a set number of days apart).one of dateinterval
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: owner, sequenceSteps. Example: owner,sequenceSteps.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of sequences to return per page (1 to 100). Defaults to 50.
updated_afterstring
Only return sequences updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return sequences updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_task_getGet one Nooks task by its ID.Read-only
Get Task
Get one Nooks task by its ID. Returns the task's action, status, priority, due date, note, prospect, owner, and sequence context. Use nooks_task_get when you have the task ID. Use nooks_tasks_list to find tasks.
Inputs
idstringrequired
Nooks ID (UUID) of the task. Get it from nooks_tasks_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: owner, prospect, sequence, sequenceState, sequenceStep. Example: owner,prospect.
nooks_tasks_listList outreach tasks in Nooks, filtered by sequence, step, prospect, account, owner, action, status, priority, due date, or completion.Read-only
List Tasks
List outreach tasks in Nooks, filtered by sequence, step, prospect, account, owner, action, status, priority, due date, or completion. Returns up to 100 tasks per page with action, status, priority, due date, prospect, and owner, plus a links.next cursor. Use nooks_tasks_list to build a rep's to-do list. Use nooks_task_get for one task by ID.
Inputs
account_idstring
Only return tasks for prospects at this account. Use the account's Nooks ID (UUID) from nooks_accounts_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
actionstring
Only return tasks of these action types. Pass one or more of these values, comma-separated: call, manual_email, auto_email, manual_email_reply, auto_email_reply, basic_task, linkedin_connection_request, manual_linkedin_connection_request, manual_linkedin_message, automatic_linkedin_message, manual_sms, auto_sms. Example: call,manual_email.
completedboolean
Set to true for completed tasks only, or false for open tasks only.
due_afterstring
Only return tasks due at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
due_beforestring
Only return tasks due at or before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
enrollment_statestring
Only return tasks whose sequence enrollment is in these states. Use null for one-off tasks that are not part of a sequence. Pass one or more of these values, comma-separated: active, paused, finished, null. Example: active.
filter_idsstring
Only return tasks with these Nooks IDs, comma-separated. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
includestring
Related records to embed in the response instead of returning only their IDs (max 3). Pass one or more of these values, comma-separated: owner, prospect, sequence, sequenceState, sequenceStep. Example: owner,prospect.
owner_idstring
Only return tasks assigned to this user. Use the user's Nooks ID from nooks_users_list or nooks_me_get. Example: Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of tasks to return per page (1 to 100). Defaults to 50.
prioritystring
Only return tasks with these priorities. Pass one or more of these values, comma-separated: low, normal, high, urgent. Example: high,urgent.
prospect_idstring
Only return tasks for this prospect. Use the prospect's Nooks ID (UUID) from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
sequence_idstring
Only return tasks in this sequence. Use the sequence's Nooks ID (UUID) from nooks_sequences_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
sequence_step_idstring
Only return tasks for this sequence step. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
statusstring
Only return tasks in these statuses. Pass one or more of these values, comma-separated: pending, ready, finished, skipped, failed. Example: ready.
updated_afterstring
Only return tasks updated at or after this time. Use an ISO 8601 date-time, for example 2024-01-01T00:00:00Z.
updated_beforestring
Only return tasks updated before this time. Use an ISO 8601 date-time, for example 2024-12-31T23:59:59Z.
nooks_users_listList users with an active seat in the Nooks workspace, optionally filtered by name, email, or CRM user ID.Read-only
List Users
List users with an active seat in the Nooks workspace, optionally filtered by name, email, or CRM user ID. Returns up to 100 users per page with id, name, email, and timestamps, plus a links.next cursor. Use nooks_users_list to find user IDs for owner fields. Use nooks_me_get for the connected user.
Inputs
filter_crm_idstring
Only return the Nooks user mapped to this user ID in your connected CRM, such as a Salesforce User.Id or OwnerId. Returns an empty list if no user is mapped. Example: 0055g00000AbCdEAAZ.
filter_emailstring
Only return the user with this exact email address. Example: jane@company.com.
filter_namestring
Only return the user with this exact full name. Example: Jane Doe.
page_afterstring
Cursor for the next page. Pass the page[after] value from the links.next URL of the previous response, unchanged. Leave empty for the first page.
page_sizeinteger
Number of users to return per page (1 to 100). Defaults to 50.
nooks_prospect_note_createCreate a note on a CRM-backed Nooks prospect; Nooks writes it to the prospect's record in Salesforce or HubSpot.Write
Create Prospect Note
Create a note on a CRM-backed Nooks prospect; Nooks writes it to the prospect's record in Salesforce or HubSpot. Returns the created note. Use nooks_prospect_note_create only for prospects sourced from Salesforce or HubSpot.
Inputs
idstringrequired
Nooks ID (UUID) of the prospect. Get it from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
integration_typestringrequired
CRM the prospect comes from and where the note is created. Must match the prospect's CRM source.one of salesforcehubspot
textstringrequired
Body text of the note (1 to 65535 characters). Example: Spoke with Jane, follow up next week about pricing.
nooks_sequence_state_createEnroll a prospect in a Nooks sequence on behalf of a user, starting now or at a scheduled time.Write
Enroll Prospect in Sequence
Enroll a prospect in a Nooks sequence on behalf of a user, starting now or at a scheduled time. Returns the new enrollment (sequence state) with its id, state, and current step. Use nooks_sequence_state_create to start outreach. Enroll into a private sequence only on behalf of its owner. Get the prospect ID from nooks_prospects_list and the sequence ID from nooks_sequences_list.
Inputs
owner_idstringrequired
Nooks ID of the user who owns the enrollment and sends its outreach. Get it from nooks_users_list or nooks_me_get. Example: Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7.
prospect_idstringrequired
Nooks ID (UUID) of the prospect. Get it from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
sequence_idstringrequired
Nooks ID (UUID) of the sequence. Get it from nooks_sequences_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
mailbox_idstring
ID of the mailbox to send sequence emails from. If omitted, the owner's primary mailbox is used. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
scheduled_atstring
When to start the sequence, with a timezone offset. If omitted, it starts immediately. Use an ISO 8601 date-time, for example 2024-06-01T09:00:00-07:00.
sequence_step_idstring
ID of the sequence step to start on. If omitted, the prospect starts on the first step. Must belong to the chosen sequence. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
statestring
State to create the enrollment in: active to start outreach, or paused to hold it. Defaults to active.one of activepaused
nooks_task_completeMark a Nooks task as completed.Write
Complete Task
Mark a Nooks task as completed. For a sequence task, this also advances the prospect to the next step. Returns the updated task. Use nooks_task_complete after the task's call, email, or other action has been done.
Inputs
idstringrequired
Nooks ID (UUID) of the task. Get it from nooks_tasks_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
nooks_task_createCreate a one-off Nooks task (not part of a sequence) for a prospect, such as a call or manual email.Write
Create Task
Create a one-off Nooks task (not part of a sequence) for a prospect, such as a call or manual email. Returns the created task with its id, status, and due date. Nooks syncs it to the CRM automatically. Use nooks_task_create for ad-hoc follow-ups. Use nooks_sequence_state_create to start a full sequence.
Inputs
actionstringrequired
Type of task to create. Example: call.one of callmanual_emailmanual_email_replybasic_tasklinkedin_connection_requestmanual_linkedin_connection_requestmanual_linkedin_messagemanual_sms
due_atstringrequired
When the task is due, as an ISO 8601 date-time with a timezone offset. Example: 2024-06-01T09:00:00-07:00.
owner_idstringrequired
Nooks ID of the user the task is assigned to. Get it from nooks_users_list or nooks_me_get. Example: Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7.
prospect_idstringrequired
Nooks ID (UUID) of the prospect. Get it from nooks_prospects_list. Example: 3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f.
notestring
Instructions or context for the task. Example: Ask about Q3 budget.
prioritystring
Task priority. Defaults to normal.one of lownormalhighurgent

Workflows

List today’s open call tasks

Node.js
Python

const tasks = await actions.executeTool({
  connector: 'nooks',
  identifier: 'user_123',
  toolName: 'nooks_tasks_list',
  toolInput: {
    action: 'call',
    status: 'ready',
    due_before: '2024-06-01T23:59:59Z',
    include: 'prospect',
  },
});
console.log(tasks);

tasks = actions.execute_tool(
    connection_name='nooks',
    identifier='user_123',
    tool_name='nooks_tasks_list',
    tool_input={
        'action': 'call',
        'status': 'ready',
        'due_before': '2024-06-01T23:59:59Z',
        'include': 'prospect',
    },
)
print(tasks)

Enroll a prospect in a sequence

Find the prospect with nooks_prospects_list (for example by filter_emails), the sequence with nooks_sequences_list, and your user ID with nooks_me_get.

Node.js
Python

const enrollment = await actions.executeTool({
  connector: 'nooks',
  identifier: 'user_123',
  toolName: 'nooks_sequence_state_create',
  toolInput: {
    prospect_id: '3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f',
    sequence_id: '9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
    owner_id: 'Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7',
  },
});
console.log(enrollment);

enrollment = actions.execute_tool(
    connection_name='nooks',
    identifier='user_123',
    tool_name='nooks_sequence_state_create',
    tool_input={
        'prospect_id': '3f2b8c1e-4d5a-4b6c-9e7f-1a2b3c4d5e6f',
        'sequence_id': '9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d',
        'owner_id': 'Xk3pQ9rT2vLmN8sA1bC4dE5fG6h7',
    },
)
print(enrollment)

Page through results

List tools return up to 100 records per page. When links.next is present in the response, pass its page[after] value as page_after to get the next page.

Node.js
Python

const nextPage = await actions.executeTool({
  connector: 'nooks',
  identifier: 'user_123',
  toolName: 'nooks_calls_list',
  toolInput: { page_size: 100, page_after: 'eyJpZCI6IjNmMmI4YzFlIn0' },
});

next_page = actions.execute_tool(
    connection_name='nooks',
    identifier='user_123',
    tool_name='nooks_calls_list',
    tool_input={'page_size': 100, 'page_after': 'eyJpZCI6IjNmMmI4YzFlIn0'},
)

Setup

Install the SDK

Set your credentials

Create the Nooks connection

Register an OAuth app

Create a connection in Scalekit

Get OAuth client credentials from Nooks

Add credentials in Scalekit

Authorize a user and make your first call

Tools

Call it

Returns

Get Account

Inputs

List Accounts

Inputs

List Call Dispositions

Inputs

Get Call

Inputs

List Calls

Inputs

Get Email

Inputs

List Emails

Inputs

Get Current User

Inputs

Get Prospect

Inputs

List Prospects

Inputs

Get Sequence

Inputs

List Sequence Enrollments

Inputs

List Sequences

Inputs

Get Task

Inputs

List Tasks

Inputs

List Users

Inputs

Create Prospect Note

Inputs

Enroll Prospect in Sequence

Inputs

Complete Task

Inputs

Create Task

Inputs

Workflows

Related: other CRM & Sales connectors