> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nutshell

> How to set up the Nutshell connector, plus the actions and events that are available.

![Nutshell](https://stackone-logos.com/api/nutshell/filled/svg)

v1.4.0[See changelog](https://docs.stackone.com/connectors/nutshell/changelog.md)

[75 actions](#actions) · [26 events](#events) · 1 auth method

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/nutshell/guides/connector-profile/api-key.md)
>
> Use your Nutshell email and API key for Basic Authentication.

Optionally, configure receiving Events for Nutshell into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/nutshell/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/nutshell/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

75 actions

ActionDescription

List Users`nutshell_list_users`

Retrieve a list of all users in the Nutshell account

Get User`nutshell_get_user`

Retrieve a specific user by their ID

List Contacts`nutshell_list_contacts`

Retrieve a paginated list of contacts in Nutshell

List Contact Items`nutshell_list_contact_items`

Retrieve all contacts in a list item format with additional filtering and sorting fields

Get Contact`nutshell_get_contact`

Retrieve a specific contact by their ID

Create Contact`nutshell_create_contact`

Create a new contact (person) in Nutshell

Update Contact`nutshell_update_contact`

Update an existing contact by ID using JSON Patch operations

Delete Contact`nutshell_delete_contact`

Delete a contact from Nutshell

Undelete Contact`nutshell_undelete_contact`

Restore a previously deleted contact by their ID

List Contact Fields`nutshell_list_contact_fields`

Retrieve the list of fields available for contacts

List Contact Custom Field Attributes`nutshell_list_contact_custom_field_attributes`

Retrieve all contact custom field definitions in the Nutshell instance

Get Contact Custom Fields`nutshell_get_contact_custom_fields`

Retrieve custom field values for a specific contact

Create Contact Custom Field`nutshell_create_contact_custom_field`

Create a new custom field definition for contacts

List Accounts`nutshell_list_accounts`

Retrieve a paginated list of accounts in Nutshell

List Account Items`nutshell_list_account_items`

Retrieve all accounts in a list item format with additional filtering and sorting fields

Get Account`nutshell_get_account`

Retrieve a specific account by its ID

Create Account`nutshell_create_account`

Create a new account (company) in Nutshell

Update Account`nutshell_update_account`

Update an existing account by ID using JSON Patch operations

Delete Account`nutshell_delete_account`

Delete an account from Nutshell

Undelete Account`nutshell_undelete_account`

Restore a previously deleted account by its ID

List Account Fields`nutshell_list_account_fields`

Retrieve the list of fields available for accounts

List Account Types`nutshell_list_account_types`

Retrieve all account types in the Nutshell instance

List Industries`nutshell_list_industries`

Retrieve the list of valid industries in Nutshell

List Account Custom Field Attributes`nutshell_list_account_custom_field_attributes`

Retrieve all account custom field definitions in the Nutshell instance

Get Account Custom Fields`nutshell_get_account_custom_fields`

Retrieve custom field values for a specific account

Create Account Custom Field`nutshell_create_account_custom_field`

Create a new custom field definition for accounts

List Leads`nutshell_list_leads`

Retrieve a paginated list of leads in Nutshell

List Lead Items`nutshell_list_lead_items`

Retrieve all leads in a list item format with additional filtering and sorting fields

Get Lead`nutshell_get_lead`

Retrieve a specific lead by its ID

Create Lead`nutshell_create_lead`

Create a new lead (sales opportunity) in Nutshell

Update Lead`nutshell_update_lead`

Update an existing lead by ID using JSON Patch operations

Delete Lead`nutshell_delete_lead`

Delete a lead from Nutshell

Undelete Lead`nutshell_undelete_lead`

Restore a previously deleted lead by its ID

Update Lead Status`nutshell_update_lead_status`

Update the status of a lead including outcome, competitors, and products

Set Lead Pipeline`nutshell_set_lead_stageset`

Assign a lead to a pipeline (stageset)

Reopen Lead`nutshell_reopen_lead`

Reopen a previously closed lead

Watch Lead`nutshell_watch_lead`

Toggle notifications for a lead

Get Lead Stages`nutshell_get_lead_stages`

Retrieve the stage progression data for a specific lead

Get Leads Report`nutshell_get_leads_report`

Generate a report for leads with customizable filtering and grouping

List Lead Fields`nutshell_list_lead_fields`

Retrieve the list of fields available for leads

List Lead Custom Field Attributes`nutshell_list_lead_custom_field_attributes`

Retrieve all lead custom field definitions in the Nutshell instance

Get Lead Custom Fields`nutshell_get_lead_custom_fields`

Retrieve custom field values for a specific lead

Create Lead Custom Field`nutshell_create_lead_custom_field`

Create a new custom field definition for leads

List Outcomes`nutshell_list_outcomes`

Retrieve a list of all lead outcomes in Nutshell

Get Outcome`nutshell_get_outcome`

Retrieve a specific lead outcome by its ID

List Activities`nutshell_get_activities`

Retrieve a list of activities in Nutshell

Get Activity`nutshell_get_activity`

Retrieve a specific activity by its ID

Create Activity`nutshell_create_activity`

Create a new activity in Nutshell

Update Activity`nutshell_update_activity`

Update an existing activity by its ID

List Activity Types`nutshell_list_activity_types`

Retrieve all available activity types in Nutshell

List Tasks`nutshell_list_tasks`

Retrieve a paginated list of tasks in Nutshell

Get Task`nutshell_get_task`

Retrieve a specific task by its ID

Create Task`nutshell_create_task`

Create a new task in Nutshell

Update Task`nutshell_update_task`

Update an existing task by ID using JSON Patch operations

Delete Task`nutshell_delete_task`

Delete a task from Nutshell

List Notes`nutshell_list_notes`

Retrieve a paginated list of notes in Nutshell

Get Note`nutshell_get_note`

Retrieve a specific note by its ID

Create Note`nutshell_create_note`

Create a new note in Nutshell

Delete Note`nutshell_delete_note`

Delete a note from Nutshell

Undelete Note`nutshell_undelete_note`

Restore a previously deleted note by its ID

List Tags`nutshell_list_tags`

Retrieve a list of all tags in the Nutshell instance

Create Tag`nutshell_create_tag`

Create a new tag in Nutshell

Delete Tag`nutshell_delete_tag`

Delete one or more tags from Nutshell

Undelete Tag`nutshell_undelete_tag`

Restore a previously deleted tag by its ID

List Sources`nutshell_list_sources`

Retrieve a list of lead sources in Nutshell

Create Source`nutshell_create_source`

Create a new lead source in Nutshell

Delete Source`nutshell_delete_source`

Delete a lead source from Nutshell

Undelete Source`nutshell_undelete_source`

Restore a previously deleted lead source by its ID

List Products`nutshell_list_products`

Retrieve a list of products in Nutshell

Get Product`nutshell_get_product`

Retrieve a specific product by its ID

Delete Product`nutshell_delete_product`

Delete a product from Nutshell

Undelete Product`nutshell_undelete_product`

Restore a previously deleted product by its ID

List Product Categories`nutshell_list_product_categories`

Retrieve all product categories in Nutshell

Get Product Category`nutshell_get_product_category`

Retrieve a specific product category by its ID

Create Product Category`nutshell_create_product_category`

Create a new product category in Nutshell

## Events

Tags

Select all
|
Clear

Accounts

Activities

Assignments

Contacts

Files

Health Checks

Leads

Notes

Webhooks

No tags found

26 events

EventDescriptionTags

Active Check`nutshell_active_check`

Responds to Nutshell's ping request with a 200 OK to confirm the webhook endpoint is active.

Health Checks

Contact Created`nutshell_webhook_contacts_created`

Emitted when a new contact (person) is created. Maps to Nutshell event where payloadType is `contacts` and action is \`cr...

ContactsWebhooks

Contact Updated`nutshell_webhook_contacts_updated`

Emitted when a contact's attributes are changed (name, address, phone, custom fields, owner, description, etc.). Maps to...

ContactsWebhooks

Contact Deleted`nutshell_webhook_contacts_deleted`

Emitted when a contact is deleted. Maps to Nutshell event where payloadType is `contacts` and action is `delete`.

ContactsWebhooks

Account Created`nutshell_webhook_accounts_created`

Emitted when a new company (account) is created. Maps to Nutshell event where payloadType is `accounts` and action is \`c...

AccountsWebhooks

Account Updated`nutshell_webhook_accounts_updated`

Emitted when a company's attributes are changed (name, address, industry, custom fields, owner, description, etc.). Maps...

AccountsWebhooks

Account Deleted`nutshell_webhook_accounts_deleted`

Emitted when a company (account) is deleted. Maps to Nutshell event where payloadType is `accounts` and action is \`delet...

AccountsWebhooks

Lead Created`nutshell_webhook_leads_created`

Emitted when a new lead is created. Maps to Nutshell event where payloadType is `leads` and action is `create`.

LeadsWebhooks

Lead Updated`nutshell_webhook_leads_updated`

Emitted when a lead's attributes change (description, due time, confidence, stage, value, products, etc.). Maps to Nutsh...

LeadsWebhooks

Lead Deleted`nutshell_webhook_leads_deleted`

Emitted when a lead is deleted. Maps to Nutshell event where payloadType is `leads` and action is `delete`.

LeadsWebhooks

Activity Created`nutshell_webhook_activities_created`

Emitted when a new activity is created. Maps to Nutshell event where payloadType is `activities` and action is `create`.

ActivitiesWebhooks

Activity Updated`nutshell_webhook_activities_updated`

Emitted when an activity's details change (name, description, time, status). Maps to Nutshell event where payloadType is...

ActivitiesWebhooks

Activity Deleted`nutshell_webhook_activities_deleted`

Emitted when an activity is deleted. Maps to Nutshell event where payloadType is `activities` and action is `delete`.

ActivitiesWebhooks

Activity Logged`nutshell_webhook_activities_logged`

Emitted when an activity is logged (marked as completed). Maps to Nutshell event where payloadType is `activities` and a...

ActivitiesWebhooks

Activity Cancelled`nutshell_webhook_activities_cancelled`

Emitted when a scheduled activity is cancelled. Maps to Nutshell event where payloadType is `activities` and action is \`...

ActivitiesWebhooks

Assignment Created`nutshell_webhook_assignments_created`

Emitted when a contact, lead, or account is assigned to a user. Maps to Nutshell event where payloadType is \`assignments...

AssignmentsWebhooks

Assignment Updated`nutshell_webhook_assignments_updated`

Emitted when an assignment is updated (reassigned to a different user). Maps to Nutshell event where payloadType is \`ass...

AssignmentsWebhooks

Assignment Deleted`nutshell_webhook_assignments_deleted`

Emitted when an assignment is removed. Maps to Nutshell event where payloadType is `assignments` and action is `delete`.

AssignmentsWebhooks

Note Created`nutshell_webhook_notes_created`

Emitted when a note is added to a contact, account, or lead. Maps to Nutshell event where payloadType is `notes` and act...

NotesWebhooks

Note Updated`nutshell_webhook_notes_updated`

Emitted when a note is edited. Maps to Nutshell event where payloadType is `notes` and action is `update`.

NotesWebhooks

Note Deleted`nutshell_webhook_notes_deleted`

Emitted when a note is deleted. Maps to Nutshell event where payloadType is `notes` and action is `delete`.

NotesWebhooks

Contact Merged`nutshell_webhook_contacts_merged`

Emitted when two contacts are merged into one. The changes array contains the merged\_with\_id. Maps to Nutshell event whe...

ContactsWebhooks

Account Merged`nutshell_webhook_accounts_merged`

Emitted when two companies (accounts) are merged into one. Maps to Nutshell event where payloadType is `accounts` and ac...

AccountsWebhooks

Lead Merged`nutshell_webhook_leads_merged`

Emitted when two leads are merged into one. Maps to Nutshell event where payloadType is `leads` and action is `merge`.

LeadsWebhooks

File Uploaded`nutshell_webhook_files_created`

Emitted when a file is uploaded to a contact, account, or lead. Maps to Nutshell event where payloadType is `files` and...

FilesWebhooks

File Deleted`nutshell_webhook_files_deleted`

Emitted when a file is deleted from a contact, account, or lead. Maps to Nutshell event where payloadType is `files` and...

FilesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.