First-party app
Outreach

Outreach

Manage prospects, accounts, opportunities, sequences, tasks and webhooks in Outreach through its JSON:API REST API.

stable Customer Relationship ManagementMarketing

About

Outreach ships in the w6w first-party pack. It declares 30 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.

App id
io.w6w.outreach
Version
0.1.0
Author
w6w
Licence
MIT
Categories
Customer Relationship Management · Marketing

Overview

Outreach is a sales engagement platform: prospects and accounts are worked through multi-step sequences of emails, calls and tasks, and the results flow into opportunities. This app gives a workflow the core of that surface over Outreach’s JSON:API REST API (v2).

It covers the full create/read/update/delete lifecycle for prospects and accounts, reading and creating opportunities, listing sequences, and the sequence-state lifecycle that actually starts and stops outreach to a prospect: enrolling a prospect in a sequence, then pausing, resuming or finishing them. It also lists and creates tasks, marks them complete, creates prospect notes, lists mailings and users, and manages webhooks so a workflow can react to Outreach events instead of polling.

Every list action speaks Outreach’s own filter, sort, include, sparse-fieldset and cursor-pagination grammar, and returns the JSON:API document as Outreach sent it plus a ready-to-use nextCursor. Webhook signing secrets and cleanup tokens are removed from every response, and the health checks read Outreach’s documented rate-limit headers.

Build with Outreach

Three routes to the same 30 actions. The Workflow tab is generated from Outreach's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.

Create Account

account-create

Create an account (company). Retrying a create can produce a duplicate.

Delete Account

account-delete

Permanently delete an account by ID.

Get Account

account-get

Fetch one account by ID, optionally with related resources included.

List Accounts

account-list

List accounts (companies) with Outreach filters, sorting and cursor pagination. Unnamed accounts are not returned by default.

Update Account

account-update

Update an account. Only the fields you supply change.

List Mailings

mailing-list

List mailings (emails sent or scheduled through Outreach) with their delivery, open, click and reply state.

Create Opportunity

opportunity-create

Create an opportunity, optionally tied to an account, owner and stage.

Get Opportunity

opportunity-get

Fetch one opportunity by ID.

List Opportunities

opportunity-list

List opportunities with Outreach filters, sorting and cursor pagination.

Create Prospect

prospect-create

Create a prospect. Outreach has no idempotency key, so retrying a create can produce a duplicate; look the prospect up first when that matters.

Delete Prospect

prospect-delete

Permanently delete a prospect by ID.

Get Prospect

prospect-get

Fetch one prospect by ID, optionally with related resources included.

List Prospects

prospect-list

List prospects with Outreach filters, sorting and cursor pagination. Since 1 Oct 2026 the `contactHistogram` attribute is no longer in the default payload; request it with Fields.

Create Prospect Note

prospect-note-create

Attach a note to a prospect.

Update Prospect

prospect-update

Update a prospect. Only the fields you supply change.

Get Sequence

sequence-get

Fetch one sequence by ID, including its enabled/locked state and engagement counts.

List Sequences

sequence-list

List sequences. Use this to find the sequence ID that Add Prospect to Sequence needs.

Add Prospect to Sequence

sequence-state-create

Enroll a prospect in a sequence by creating a sequence state. The prospect, the sequence and the mailbox the emails go out from are all required; the sequence's automation starts immediately.

Finish Sequence State

sequence-state-finish

Finishes a sequence state, removing the prospect from the sequence, by sequence state ID.

List Sequence States

sequence-state-list

List sequence states — one per prospect enrolled in a sequence. Filter with `{"prospect": {"id": "1"}}` or `{"sequence": {"id": "2"}}` to see who is in what, and read `state` (active, pending, finished, paused, disabled, failed, bounced, opted_out).

Pause Sequence State

sequence-state-pause

Pauses an active sequence state, by sequence state ID.

Resume Sequence State

sequence-state-resume

Resumes a paused sequence state, by sequence state ID.

Create Task

task-create

Create a manual task for a prospect, assigned to an owner.

Get Task

task-get

Fetch one task by ID.

List Tasks

task-list

List tasks. For a rep's open work filter `{"state": "incomplete", "owner": {"id": "1"}}` and include `prospect`.

Mark Task Complete

task-mark-complete

Mark a task complete, optionally attaching a note to its prospect.

List Users

user-list

List Outreach users, e.g. to look up the owner ID to assign a prospect to.

Create Webhook

webhook-create

Subscribe a URL to Outreach events. Resource and action default to `*` (everything). If you set a secret, Outreach signs each delivery with an HMAC in `Outreach-Webhook-Signature`. The secret and the cleanup token are not returned by this action.

Delete Webhook

webhook-delete

Delete a webhook by ID.

List Webhooks

webhook-list

List webhooks. Each webhook's signing `secret` and `cleanupToken` are removed from the result.

A workflow step names the app and the action, and the editor fills in the connection when you pick one. This is the Step shape from the workflow spec, carrying Outreach's real ids.

{
  "manifestVersion": "2",
  "name": "outreach-example",
  "steps": [
    {
      "id": "account-get",
      "uses": {
        "app": "io.w6w.outreach",
        "action": "account-get",
        "connection": "conn_YOUR_CONNECTION_ID"
      },
      "with": {
        "id": "<id>"
      }
    }
  ]
}

Here are some of the things you can do

  • Get Account

    read
    account-get
  • Create Account

    perform
    account-create
  • List Accounts

    read
    account-list
  • Update Account

    perform
    account-update
  • List Mailings

    read
    mailing-list

+25 more actions available

Every app-specific value here is a blank you have to fill in. An app action is reached through the connection that authenticates it, so the address is a connection id, not the app id — and connections belong to your account, so a public page cannot know yours. Create one for Outreach, then fill in the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the parameters that action declares. The call itself is real — the shape is transcribed from the studio's own snippet builder, which prints the same kind of blanks — but nothing in it is specific to Outreach. The Workflow tab is where this app's real ids are.

Install
npm install @w6w/sdk
yarn add @w6w/sdk
pnpm add @w6w/sdk
deno add npm:@w6w/sdk
Code
import { W6wClient, isActionRun } from "@w6w/sdk";

// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();

const envelope = await client.run({
  urn: "conn_YOUR_CONNECTION_ID",
  action: "account-get",
  payload: {
    id: "<value>",
    // include: "<value>",
    // fields: "<value>",
  },
});

if (isActionRun(envelope)) console.log(envelope.value);
Install the CLI
npm install -g @w6w/cli
CLI
w6w run conn_YOUR_CONNECTION_ID --action account-get --payload '{"id":"<value>"}'

Give an AI agent Outreach — without giving it Outreach's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.

One tool call
{
  "name": "w6w_invoke",
  "arguments": {
    "ref": "app:io.w6w.outreach#account-get",
    "input": {
      "id": "<id>"
    }
  }
}

Every tool names its target with a single ref. The app: form above doesn't name a connection at all — the host resolves which of the caller's Outreach connections to sign with, and refuses rather than guesses when the answer is ambiguous.

What the agent gets

Credentials it can't read

The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.

A tool surface scoped to the caller

Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.

A durable workflow in one call

Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.

Health-aware discovery

Outreach's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.

The MCP surface is part of the hosted platform. Outreach itself is MIT, and the runtime that executes it is source-available (FSL).

Request MCP access

Health checks

Outreach declares its own checks, so its health is a property of the app rather than something the host guesses at.

service

Outreach platform status

quota

API rate-limit headroom

Remaining requests in the current per-user hourly window (10,000/hour), from the X-RateLimit-* response headers.