Connector

Tool reference

Fifteen tools are registered. Open a tool for its parameters and what it returns.

whoamiwhoami()Returns the Hivewave user id and email for the signed-in account.
list_brandslist_brands()Lists the brands on this account. Planning waits until you confirm one, including when there is only one brand.
plan_directionplan_direction(brand_id?, message?, job_id?)Finds stores for a product on the brand you confirmed. The first call returns a job id. A later call returns the direction: which kind of store, and why this product fits. It does not approve the direction and does not start the search.
approve_directionapprove_direction(strategy_id, direction_id)Approves a direction you just confirmed. That approval starts the search. The reply has no contacts.
list_active_directionslist_active_directions(brand_id)Lists the approved directions for the brand you confirmed.
list_scouted_candidateslist_scouted_candidates(brand_id)Lists stores found so far: the store name, why it matched, and a link into Hivewave. Email and phone stay in the app.
list_email_templateslist_email_templates(brand_id)Lists the outreach email templates for a brand. Archiving a template and making one the default stay in the app.
get_email_templateget_email_template(template_id)Reads one template's voice fields, including the merchant's postal address, plus a link to the template library.
create_email_templatecreate_email_template(brand_id, name, description?, structure?, opening_style?, cta_style?, sign_off?, tone_notes?, subject_pattern?, must_include?, avoid?, anchor_examples?, compliance_footer_on_first_touch?, compliance_postal_address?)Creates an outreach template for a brand. Does not make it the default. Archiving and choosing the default stay in the app.
update_email_templateupdate_email_template(template_id, name?, description?, structure?, opening_style?, cta_style?, sign_off?, tone_notes?, subject_pattern?, must_include?, avoid?, anchor_examples?, compliance_footer_on_first_touch?, compliance_postal_address?)Edits a template's voice fields. Omitted fields stay as they are. Does not archive the template or change which one is the default.
preview_email_templatepreview_email_template(template_id?, direction_path_id?, job_id?, candidate_id?, cta_style?, avoid?, subject_pattern?, must_include?, anchor_examples?)Renders a sample outreach email from a template against an approved direction. The first call returns a job id. A later call with that job id returns the sample subject and body. When no candidate is named, the server picks the newest contactable one on that direction. Optional brief fields apply to this sample only and do not save the template. The result has no recipient email, name, or phone.
get_outreach_summaryget_outreach_summary(brand_id)Shows how outreach is going for a brand: counts, the next send day, and the progress phase. No contacts.
list_outreach_messageslist_outreach_messages(brand_id, bucket, direction_path_id?, q?, limit?, offset?)Lists outreach messages in one inbox bucket. Review and scheduled rows include subject and body. Sent, failed, and held rows include subject and status and do not include the body. Held rows include why they are held. Search matches subject and store name. Email and phone are not included. get_outreach_message returns one body from any bucket. Sending stays in the app.
get_outreach_messageget_outreach_message(message_id)Reads one outreach message, including its subject and body, whichever bucket it is in. Email and phone are not included.
get_outreach_send_statusget_outreach_send_status(brand_id)Reads a send the person already started in the Hivewave app. Returns null when nothing is running. This tool does not start a send.