PedibeeDocs

Playbooks

Common requests as tool sequences, with the checks a careful agent makes along the way.

Each playbook starts from something a person might say and shows the tools to call, in order. Tool inputs are in the tool reference.

"Add Northwind and their CTO Jane"

  1. list_companies with search: "northwind" to avoid a duplicate.
  2. If none: create_company with companyName, domain (northwind.io) and contacts: [{ email, name, title }]. A company always needs at least one person.
  3. If it exists: create_contact with leadId set to the company's id. A 409 means the email is already a contact; update_contact instead.
  4. Report the company id and the contact id.

"Find everyone we haven't contacted in a month and put them in a list"

  1. list_contacts with lastContacted: "over30" (or never), limit: 50, paging with skip.
  2. create_list named by the user, or list_lists to find an existing one.
  3. add_to_list with contactIds in batches.
  4. Report how many were added.

"Send Jane a follow-up"

  1. get_contact to confirm who Jane is and check her stage. If she is replied, bounced, unsubscribed, converted or dead, say so; only use force: true if the user explicitly asks.
  2. list_signatures if a signature is wanted (signatureId: "default" is the usual choice).
  3. If several Gmail accounts are connected (list_gmail_accounts) and the user didn't say which, ask.
  4. Show the recipient, subject and body. On the user's go-ahead, send_email. For later, add sendAt.

"Launch a campaign to the Q4 list" (the safe way)

  1. list_lists to find the list and its size.
  2. list_templates if the email should start from a template; create_campaign with name, subject, html (or templateId), previewText, signatureId, and mailboxId only if the user named a Gmail.
  3. add_campaign_recipients with listIds.
  4. get_campaign_summary: shows how many will be sent, how many skipped and why, the Gmail and its remaining daily allowance, and any problem that blocks launching (a [[placeholder]], no Gmail, no recipients).
  5. preview_campaign for a real person in the audience, and send_campaign_test to the user's own inbox if they want to see it there.
  6. Show the summary and the preview. Only on the user's go-ahead, launch_campaign (now, or with scheduledAt).
  7. Later: get_campaign for sent, opened, clicked and replied counts; list_campaign_recipients for who was skipped; retry_failed_recipients if Gmail failed for some (again, with a go-ahead).

"Set up a three-step follow-up sequence and enroll the webinar list"

  1. create_sequence with name, optional mailboxId and signatureId, and steps: each with subject, html, waitDays and threadMode (REPLY keeps follow-ups in the first email's thread).
  2. get_sequence_summary to check for blocking problems; preview_sequence_step for one step.
  3. activate_sequence.
  4. enroll_in_sequence with listIds and dryRun: true. Show who would be skipped and why.
  5. On the go-ahead, enroll_in_sequence without dryRun.
  6. list_sequence_enrollments to follow progress; update_sequence_enrollments with action: "stop" for anyone the user wants out. Remind the user to mark replies on the contact: the server can't read inboxes.

"What happened with Acme?"

  1. list_companies with search: "acme", then get_company for the people and engagement counts.
  2. list_contacts with leadId for each person's stage, last contact and whether they opened, clicked or replied.
  3. Summarise in a few lines; don't paste raw records.

"Warm up the new sales@ account"

  1. list_gmail_accounts to find it. get_warmup to see whether one exists.
  2. add_warmup_inbox for each inbox the user controls (3 to 50 are needed). Ask for them; never invent addresses.
  3. Show the schedule and the inboxes. On the go-ahead, start_warmup (the first email goes out at once if the window is open).
  4. get_warmup later for today's count and the day number; pause_warmup, resume_warmup, update_warmup_schedule, stop_warmup as asked.

"Record that the customer upgraded"

  1. track_event with name (your own event name, like plan_upgraded), contact: { email } and properties. contactFields can set custom fields at the same time.
  2. list_events to confirm it was recorded and which automations it started.
  3. If the user wants an email to follow, that's an automation: list_automations to see what exists; automations are built in the Pedibee dashboard, where pause_automation and resume_automation can also be driven from here.

Things an agent should not try

  • Reading replies or inboxes: there is no tool, by design.
  • Removing someone from the do-not-email list unless the user says the recipient asked to hear from them again, and confirms.
  • Building automations or the email designer's block layouts: use the dashboard; agents work with HTML templates.
  • Connecting Gmail accounts or changing the team, tracking domain or settings.

On this page