First-party app
Yelp

Yelp Leads

Read and respond to Leads generated by Yelp users, for advertising and listing-management reseller partners.

stable MarketingCustomer Relationship Management

About

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

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

Overview

The Yelp Leads API notifies a partner about every new interaction — a new lead, a new message, a phone-number opt-in — on the businesses it is subscribed to (Business Subscriptions API, subscription type WEBHOOK), and lets the partner read the full conversation and reply on the business’s behalf.

This app covers the whole of that surface: reading a lead’s details and its full event timeline (with cursor pagination), writing a text-message reply into an existing lead, marking a lead as replied through an out-of-Yelp channel (phone or email), marking events as read, listing the lead IDs a business has received (with time-range filtering), and reading a lead’s cost metrics.

Access to the Leads API itself is restricted to Yelp advertising and listing-management reseller partners meeting a minimum spend requirement — Yelp’s own recommendation for everyone else is its no-code Zapier integration.

Build with Yelp Leads

Three routes to the same 7 actions. The Workflow tab is generated from Yelp Leads'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.

Get Lead

get-lead

Read details for a given Yelp Lead ID.

Get Lead Events

get-lead-events

List the events (messages, attachments, other interactions) on a lead.

Get Lead IDs for a Business

get-lead-ids-for-business

List the Lead IDs a Yelp business has received, optionally filtered by time.

Get Lead Metrics

get-lead-metrics

Read a lead's cost metrics (currently: cost per lead).

Mark Lead as Replied

mark-lead-as-replied

Mark a lead as replied through a channel outside the Leads API (phone or email).

Mark Lead Event as Read

mark-lead-event-as-read

Mark a lead event, and every event before it, as read.

Write Lead Event

write-lead-event

Send a text-message reply into an existing lead's conversation.

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 Yelp Leads's real ids.

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

Here are some of the things you can do

  • Get Lead

    read
    get-lead
  • Get Lead Events

    search
    get-lead-events
  • Get Lead IDs for a Business

    search
    get-lead-ids-for-business
  • Get Lead Metrics

    read
    get-lead-metrics
  • Mark Lead as Replied

    perform
    mark-lead-as-replied

+2 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 Yelp Leads, 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 Yelp Leads. 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: "get-lead",
  payload: {
    leadId: "<value>",
  },
});

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

Give an AI agent Yelp Leads — without giving it Yelp Leads'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.yelp-leads#get-lead",
    "input": {
      "leadId": "<leadId>"
    }
  }
}

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 Yelp Leads 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

Yelp Leads'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. Yelp Leads itself is MIT, and the runtime that executes it is source-available (FSL).

Request MCP access

Health checks

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

service

Yelp platform status

quota

Rate-limit headroom