Outreach connector
OAuth 2.0CRM & SalesConnect with Outreach to manage prospects, accounts, sequences, emails, calls, and sales engagement workflows.
Outreach connector
-
Install the SDK
Section titled “Install the SDK”Terminal window npm install @scalekit-sdk/nodeTerminal window pip install scalekit -
Set your credentials
Section titled “Set your credentials”Add your Scalekit credentials to your
.envfile. 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> -
Authorize and make your first call
Section titled “Authorize and make your first call”quickstart.ts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENV_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'outreach'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Outreach:', link)process.stdout.write('Press Enter after authorizing...')await new Promise(r => process.stdin.once('data', r))// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'outreach_accounts_list',toolInput: {},})console.log(result)quickstart.py import osfrom scalekit.client import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENV_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "outreach"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Outreach:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="outreach_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)
What you can do
Section titled “What you can do”Connect this agent connector to let your agent:
- Complete tasks — Mark an existing task as complete in Outreach
- Get sequences, sequence states, webhooks — Retrieve a single sequence by ID from Outreach
- Delete sequences, opportunities, prospects — Permanently delete a sequence from Outreach by ID
- Create templates, accounts, tasks — Create a new email template in Outreach
- List tags, mailboxes, users — List all tags configured in Outreach that can be applied to prospects, accounts, and sequences
- Update tasks, templates, accounts — Update an existing task in Outreach
Tool list
Section titled “Tool list”Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.
outreach_accounts_create#Create a new account (company) in Outreach.10 params
Create a new account (company) in Outreach.
namestringrequiredName of the account (company)descriptionstringoptionalDescription of the accountdomainstringoptionalWebsite domain of the accountindustrystringoptionalIndustry of the accountlinkedin_urlstringoptionalLinkedIn company page URLlocalitystringoptionalLocation/city of the accountnumber_of_employeesintegeroptionalNumber of employees at the accountowner_idintegeroptionalID of the user (owner) to assign this account totagsarrayoptionalArray of tags to apply to the accountwebsite_urlstringoptionalWebsite URL of the accountoutreach_accounts_delete#Permanently delete an account from Outreach by ID. This action cannot be undone.1 param
Permanently delete an account from Outreach by ID. This action cannot be undone.
account_idintegerrequiredThe unique identifier of the account to deleteoutreach_accounts_get#Retrieve a single account by ID from Outreach.1 param
Retrieve a single account by ID from Outreach.
account_idintegerrequiredThe unique identifier of the account to retrieveoutreach_accounts_list#List all accounts in Outreach with optional filtering, sorting, and pagination.5 params
List all accounts in Outreach with optional filtering, sorting, and pagination.
filter_domainstringoptionalFilter accounts by domainfilter_namestringoptionalFilter accounts by namepage_offsetintegeroptionalOffset for pagination (number of records to skip)page_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending order (e.g., '-createdAt')outreach_accounts_update#Update an existing account in Outreach. Only provided fields will be changed.9 params
Update an existing account in Outreach. Only provided fields will be changed.
account_idintegerrequiredThe unique identifier of the account to updatedescriptionstringoptionalUpdated description of the accountdomainstringoptionalUpdated website domainindustrystringoptionalUpdated industry of the accountnamestringoptionalUpdated name of the accountnumber_of_employeesintegeroptionalUpdated number of employeesowner_idintegeroptionalUpdated owner user IDtagsarrayoptionalUpdated array of tagswebsite_urlstringoptionalUpdated website URLoutreach_calls_create#Log a call record in Outreach. Used to track inbound or outbound call activity against a prospect.8 params
Log a call record in Outreach. Used to track inbound or outbound call activity against a prospect.
answered_atstringoptionalISO 8601 datetime when the call was answeredcall_disposition_idintegeroptionalID of the call disposition (outcome category)call_purpose_idintegeroptionalID of the call purposedirectionstringoptionalDirection of the call. Options: inbound, outbounddurationintegeroptionalDuration of the call in secondsnotestringoptionalNote or summary about the calloutcomestringoptionalOutcome of the call (e.g., connected, no_answer, left_voicemail)prospect_idintegeroptionalID of the prospect associated with this calloutreach_calls_get#Retrieve a single call record by ID from Outreach, including direction, outcome, note, recording URL, and related prospect.1 param
Retrieve a single call record by ID from Outreach, including direction, outcome, note, recording URL, and related prospect.
call_idintegerrequiredThe unique identifier of the call to retrieveoutreach_calls_list#List call records in Outreach with optional filtering by prospect, direction, or outcome.5 params
List call records in Outreach with optional filtering by prospect, direction, or outcome.
filter_directionstringoptionalFilter calls by direction. Options: inbound, outboundfilter_prospect_idintegeroptionalFilter calls by prospect IDpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_mailboxes_get#Retrieve a single mailbox by ID from Outreach, including its email address, sender name, and sync status.1 param
Retrieve a single mailbox by ID from Outreach, including its email address, sender name, and sync status.
mailbox_idintegerrequiredThe unique identifier of the mailbox to retrieveoutreach_mailboxes_list#List all mailboxes (sender email addresses) configured in Outreach. Mailboxes are required when enrolling prospects in sequences.3 params
List all mailboxes (sender email addresses) configured in Outreach. Mailboxes are required when enrolling prospects in sequences.
filter_emailstringoptionalFilter mailboxes by email addresspage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)outreach_mailings_get#Retrieve a single mailing by ID from Outreach, including its body, subject, state, and related prospect details.1 param
Retrieve a single mailing by ID from Outreach, including its body, subject, state, and related prospect details.
mailing_idintegerrequiredThe unique identifier of the mailing to retrieveoutreach_mailings_list#List mailings (emails sent or scheduled) in Outreach with optional filtering and pagination.5 params
List mailings (emails sent or scheduled) in Outreach with optional filtering and pagination.
filter_prospect_idintegeroptionalFilter mailings by prospect IDfilter_statestringoptionalFilter by mailing state. Options: bounced, delivered, delivering, drafted, failed, opened, placeholder, queued, replied, scheduledpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_opportunities_create#Create a new opportunity in Outreach to track sales deals.8 params
Create a new opportunity in Outreach to track sales deals.
close_datestringrequiredExpected close date for the opportunity in full ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS.000Z)namestringrequiredName or title of the opportunityaccount_idintegeroptionalID of the account associated with this opportunityamountnumberoptionalMonetary value of the opportunityowner_idintegeroptionalID of the user (owner) responsible for this opportunityprobabilityintegeroptionalProbability of closing (0-100)prospect_idintegeroptionalID of the prospect (primary contact) associated with this opportunitystage_idintegeroptionalID of the opportunity stageoutreach_opportunities_delete#Permanently delete an opportunity from Outreach by ID. This action cannot be undone.1 param
Permanently delete an opportunity from Outreach by ID. This action cannot be undone.
opportunity_idintegerrequiredThe unique identifier of the opportunity to deleteoutreach_opportunities_get#Retrieve a single opportunity by ID from Outreach, including its name, amount, close date, and stage.1 param
Retrieve a single opportunity by ID from Outreach, including its name, amount, close date, and stage.
opportunity_idintegerrequiredThe unique identifier of the opportunity to retrieveoutreach_opportunities_list#List opportunities in Outreach with optional filtering by name, prospect, or account.5 params
List opportunities in Outreach with optional filtering by name, prospect, or account.
filter_namestringoptionalFilter opportunities by namefilter_prospect_idintegeroptionalFilter by prospect IDpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_opportunities_update#Update an existing opportunity in Outreach. Only provided fields will be changed.7 params
Update an existing opportunity in Outreach. Only provided fields will be changed.
opportunity_idintegerrequiredThe unique identifier of the opportunity to updateamountnumberoptionalUpdated monetary value of the opportunityclose_datestringoptionalUpdated expected close date (ISO 8601 format)namestringoptionalUpdated name of the opportunityowner_idintegeroptionalUpdated owner user IDprobabilityintegeroptionalUpdated probability of closing (0-100)stage_idintegeroptionalUpdated opportunity stage IDoutreach_prospects_create#Create a new prospect in Outreach. Provide at minimum a first name, last name, or email address.15 params
Create a new prospect in Outreach. Provide at minimum a first name, last name, or email address.
account_idintegeroptionalID of the account to associate with this prospectaddress_citystringoptionalCity of the prospect's addressaddress_countrystringoptionalCountry of the prospect's addressaddress_statestringoptionalState of the prospect's addresscompanystringoptionalCompany name of the prospectemailsarrayoptionalArray of email addresses for the prospectfirst_namestringoptionalFirst name of the prospectgithub_urlstringoptionalGitHub profile URL of the prospectlast_namestringoptionalLast name of the prospectlinkedin_urlstringoptionalLinkedIn profile URL of the prospectowner_idintegeroptionalID of the user (owner) to assign this prospect tophonesarrayoptionalArray of phone numbers for the prospecttagsarrayoptionalArray of tags to apply to the prospecttitlestringoptionalJob title of the prospectwebsite_urlstringoptionalPersonal or company website URL of the prospectoutreach_prospects_delete#Permanently delete a prospect from Outreach by ID. This action cannot be undone.1 param
Permanently delete a prospect from Outreach by ID. This action cannot be undone.
prospect_idintegerrequiredThe unique identifier of the prospect to deleteoutreach_prospects_get#Retrieve a single prospect by ID from Outreach.1 param
Retrieve a single prospect by ID from Outreach.
prospect_idintegerrequiredThe unique identifier of the prospect to retrieveoutreach_prospects_list#List all prospects in Outreach with optional filtering, sorting, and pagination.7 params
List all prospects in Outreach with optional filtering, sorting, and pagination.
filter_companystringoptionalFilter prospects by company namefilter_emailstringoptionalFilter prospects by email addressfilter_first_namestringoptionalFilter prospects by first namefilter_last_namestringoptionalFilter prospects by last namepage_offsetintegeroptionalOffset for pagination (number of records to skip)page_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending order (e.g., '-createdAt')outreach_prospects_update#Update an existing prospect in Outreach. Only provided fields will be changed.14 params
Update an existing prospect in Outreach. Only provided fields will be changed.
prospect_idintegerrequiredThe unique identifier of the prospect to updateaccount_idintegeroptionalID of the account to associate with this prospectaddress_citystringoptionalCity of the prospect's addressaddress_countrystringoptionalCountry of the prospect's addressaddress_statestringoptionalState of the prospect's addresscompanystringoptionalCompany name of the prospectemailsarrayoptionalArray of email addresses for the prospectfirst_namestringoptionalFirst name of the prospectlast_namestringoptionalLast name of the prospectlinkedin_urlstringoptionalLinkedIn profile URL of the prospectowner_idintegeroptionalID of the user (owner) to assign this prospect tophonesarrayoptionalArray of phone numbers for the prospecttagsarrayoptionalArray of tags to apply to the prospecttitlestringoptionalJob title of the prospectoutreach_sequence_states_create#Enroll a prospect in a sequence by creating a sequence state. Requires a prospect ID, sequence ID, and mailbox ID.3 params
Enroll a prospect in a sequence by creating a sequence state. Requires a prospect ID, sequence ID, and mailbox ID.
mailbox_idintegerrequiredID of the mailbox to use for sending sequence emailsprospect_idintegerrequiredID of the prospect to enroll in the sequencesequence_idintegerrequiredID of the sequence to enroll the prospect inoutreach_sequence_states_delete#Remove a prospect from a sequence by deleting the sequence state record. This action cannot be undone.1 param
Remove a prospect from a sequence by deleting the sequence state record. This action cannot be undone.
sequence_state_idintegerrequiredThe unique identifier of the sequence state to deleteoutreach_sequence_states_get#Retrieve a single sequence state (enrollment record) by ID from Outreach.1 param
Retrieve a single sequence state (enrollment record) by ID from Outreach.
sequence_state_idintegerrequiredThe unique identifier of the sequence state to retrieveoutreach_sequence_states_list#List sequence states (enrollment records) in Outreach, showing which prospects are enrolled in which sequences.5 params
List sequence states (enrollment records) in Outreach, showing which prospects are enrolled in which sequences.
filter_prospect_idintegeroptionalFilter by prospect IDfilter_sequence_idintegeroptionalFilter by sequence IDfilter_statestringoptionalFilter by state. Options: active, pending, finished, paused, disabled, failed, bounced, opted_outpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)outreach_sequence_steps_get#Retrieve a single sequence step by ID from Outreach, including its step order, action type, and associated sequence.1 param
Retrieve a single sequence step by ID from Outreach, including its step order, action type, and associated sequence.
sequence_step_idintegerrequiredThe unique identifier of the sequence step to retrieveoutreach_sequence_steps_list#List all sequence steps in Outreach. Sequence steps define the individual actions (emails, calls, tasks) within a sequence.3 params
List all sequence steps in Outreach. Sequence steps define the individual actions (emails, calls, tasks) within a sequence.
filter_sequence_idintegeroptionalFilter sequence steps by sequence IDpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)outreach_sequences_create#Create a new sequence in Outreach for automated sales engagement.5 params
Create a new sequence in Outreach for automated sales engagement.
namestringrequiredName of the sequencedescriptionstringoptionalDescription of the sequenceowner_idintegeroptionalID of the user (owner) to assign this sequence tosequence_typestringoptionalType of the sequence. Options: 'date' or 'interval'tagsarrayoptionalArray of tags to apply to the sequenceoutreach_sequences_delete#Permanently delete a sequence from Outreach by ID. This action cannot be undone and will remove all associated sequence steps.1 param
Permanently delete a sequence from Outreach by ID. This action cannot be undone and will remove all associated sequence steps.
sequence_idintegerrequiredThe unique identifier of the sequence to deleteoutreach_sequences_get#Retrieve a single sequence by ID from Outreach.1 param
Retrieve a single sequence by ID from Outreach.
sequence_idintegerrequiredThe unique identifier of the sequence to retrieveoutreach_sequences_list#List all sequences in Outreach with optional filtering and pagination.5 params
List all sequences in Outreach with optional filtering and pagination.
filter_enabledbooleanoptionalFilter by enabled status (true or false)filter_namestringoptionalFilter sequences by namepage_offsetintegeroptionalOffset for pagination (number of records to skip)page_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_sequences_update#Update an existing sequence in Outreach. Use this to rename a sequence, change its description, or enable/disable it.5 params
Update an existing sequence in Outreach. Use this to rename a sequence, change its description, or enable/disable it.
sequence_idintegerrequiredThe unique identifier of the sequence to updatedescriptionstringoptionalUpdated description of the sequenceenabledbooleanoptionalWhether the sequence should be active/enablednamestringoptionalUpdated name of the sequencetagsarrayoptionalUpdated array of tags for the sequenceoutreach_stages_get#Retrieve a single opportunity stage by ID from Outreach, including its name, color, and order.1 param
Retrieve a single opportunity stage by ID from Outreach, including its name, color, and order.
stage_idintegerrequiredThe unique identifier of the opportunity stage to retrieveoutreach_stages_list#List all opportunity stages (pipeline stages) configured in Outreach.2 params
List all opportunity stages (pipeline stages) configured in Outreach.
page_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)outreach_tags_list#List all tags configured in Outreach that can be applied to prospects, accounts, and sequences.3 params
List all tags configured in Outreach that can be applied to prospects, accounts, and sequences.
filter_namestringoptionalFilter tags by namepage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)outreach_tasks_complete#Mark an existing task as complete in Outreach. Only works for action_item and in_person tasks — call and email tasks cannot be completed this way. Use this instead of outreach_tasks_update to complete a task.2 params
Mark an existing task as complete in Outreach. Only works for action_item and in_person tasks — call and email tasks cannot be completed this way. Use this instead of outreach_tasks_update to complete a task.
task_idintegerrequiredThe unique identifier of the task to mark as completecompletion_notestringoptionalOptional note to record when marking the task completeoutreach_tasks_create#Create a new task in Outreach. Tasks can represent calls, emails, in-person meetings, or general action items. Both owner_id and prospect_id are required by the Outreach API.5 params
Create a new task in Outreach. Tasks can represent calls, emails, in-person meetings, or general action items. Both owner_id and prospect_id are required by the Outreach API.
actionstringrequiredType of action for the task. Options: action_item, call, email, in_personowner_idintegerrequiredID of the user assigned to this taskprospect_idintegerrequiredID of the prospect associated with this task (subject). Required — must provide either prospect_id or account_id.due_atstringoptionalDue date/time for the task (ISO 8601 format)notestringoptionalNote or description for the taskoutreach_tasks_delete#Permanently delete a task from Outreach by ID. This action cannot be undone.1 param
Permanently delete a task from Outreach by ID. This action cannot be undone.
task_idintegerrequiredThe unique identifier of the task to deleteoutreach_tasks_get#Retrieve a single task by ID from Outreach, including its action type, due date, note, and associated prospect.1 param
Retrieve a single task by ID from Outreach, including its action type, due date, note, and associated prospect.
task_idintegerrequiredThe unique identifier of the task to retrieveoutreach_tasks_list#List tasks in Outreach with optional filtering by state, action type, prospect, or due date.6 params
List tasks in Outreach with optional filtering by state, action type, prospect, or due date.
filter_prospect_idintegeroptionalFilter tasks by prospect IDfilter_statestringoptionalFilter tasks by state. Options: incomplete, completefilter_task_typestringoptionalFilter tasks by task type. Options: action_item, call, email, in_personpage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_tasks_update#Update an existing task in Outreach. Supports changing action, note, and due date. To mark a task complete, use the outreach_tasks_complete tool instead.4 params
Update an existing task in Outreach. Supports changing action, note, and due date. To mark a task complete, use the outreach_tasks_complete tool instead.
task_idintegerrequiredThe unique identifier of the task to updateactionstringoptionalUpdated action type. Options: action_item, call, email, in_persondue_atstringoptionalUpdated due date/time for the task (ISO 8601 format)notestringoptionalUpdated note or description for the taskoutreach_templates_create#Create a new email template in Outreach. Templates can be used in sequences and for manual email sends.5 params
Create a new email template in Outreach. Templates can be used in sequences and for manual email sends.
namestringrequiredName of the templatebody_htmlstringoptionalHTML body content of the templateowner_idintegeroptionalID of the user who owns this templatesubjectstringoptionalEmail subject line of the templatetagsarrayoptionalArray of tags to apply to the templateoutreach_templates_delete#Permanently delete an email template from Outreach by ID. This action cannot be undone.1 param
Permanently delete an email template from Outreach by ID. This action cannot be undone.
template_idintegerrequiredThe unique identifier of the template to deleteoutreach_templates_get#Retrieve a single email template by ID from Outreach, including its subject, body, and usage statistics.1 param
Retrieve a single email template by ID from Outreach, including its subject, body, and usage statistics.
template_idintegerrequiredThe unique identifier of the template to retrieveoutreach_templates_list#List email templates in Outreach with optional filtering by name.4 params
List email templates in Outreach with optional filtering by name.
filter_namestringoptionalFilter templates by namepage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_templates_update#Update an existing email template in Outreach. Only provided fields will be changed.5 params
Update an existing email template in Outreach. Only provided fields will be changed.
template_idintegerrequiredThe unique identifier of the template to updatebody_htmlstringoptionalUpdated HTML body contentnamestringoptionalUpdated name of the templatesubjectstringoptionalUpdated email subject linetagsarrayoptionalUpdated array of tagsoutreach_users_get#Retrieve a single Outreach user by ID, including their name, email, and role information.1 param
Retrieve a single Outreach user by ID, including their name, email, and role information.
user_idintegerrequiredThe unique identifier of the user to retrieveoutreach_users_list#List all users in the Outreach organization with optional filtering and pagination.4 params
List all users in the Outreach organization with optional filtering and pagination.
filter_emailstringoptionalFilter users by email addresspage_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)sortstringoptionalSort field. Prefix with '-' for descending orderoutreach_webhooks_create#Create a new webhook in Outreach to receive event notifications at a specified URL. Outreach will POST event payloads to the provided URL when subscribed events occur.4 params
Create a new webhook in Outreach to receive event notifications at a specified URL. Outreach will POST event payloads to the provided URL when subscribed events occur.
urlstringrequiredThe HTTPS URL to receive webhook event payloadsactionstringoptionalThe event action to subscribe to (e.g., created, updated, deleted)resource_typestringoptionalThe resource type to subscribe to events for (e.g., prospect, account, sequenceState)secretstringoptionalA secret string used to sign webhook payloads for verificationoutreach_webhooks_delete#Permanently delete a webhook from Outreach by ID. Outreach will stop sending event notifications to the associated URL.1 param
Permanently delete a webhook from Outreach by ID. Outreach will stop sending event notifications to the associated URL.
webhook_idintegerrequiredThe unique identifier of the webhook to deleteoutreach_webhooks_get#Retrieve a single webhook configuration by ID from Outreach.1 param
Retrieve a single webhook configuration by ID from Outreach.
webhook_idintegerrequiredThe unique identifier of the webhook to retrieveoutreach_webhooks_list#List all webhooks configured in Outreach for receiving event notifications.2 params
List all webhooks configured in Outreach for receiving event notifications.
page_offsetintegeroptionalOffset for paginationpage_sizeintegeroptionalNumber of results per page (max 1000)