website_visitors

Identify website visitor by email

Name the person behind a browser from the customer's own backend, after a login or a signup: the site, the first-party visitor id the page holds (_gs_vid), the email, and a form name when a form was submitted (it becomes the fact website_form_submitted of the open session). The person is found by email in the team's tables; nobody matched leaves the email on the row as identified_email; an address on the team's own site marks the visit internal; a visitor bound by a code or by hand keeps its person. On a site set to companies it names nobody: no bind, no identified_email, no fact, only the internal rule; the form still joins the session's events. A visitor id the collector has not seen yet is 422 relation_not_found: retry in a few seconds. For an agent in the app, identify_website_visitor is the tool.

Contract:

  • MCP tool identify_website_visitor_by_email, registry package mcp.signals/website_visitors, mount signals.visits.
  • Operation action, response envelope action.
  • Flags: none.
post/api/website-visitors/identify

Request

  • Base URL
    https://beta.getsales.io/signals/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

site_sidstring required

The site the page belongs to.

visitor_idstring required

The first-party visitor id the page holds (_gs_vid), as the customer's backend read it from the browser.

emailstring required

The address the person logged in or signed up with; the person is found by it in the team's tables.

namestring nullable

Taken as the script's identify takes it; not stored until the inbound lead slice.

companystring nullable

Taken as the script's identify takes it; not stored until the inbound lead slice.

formstring nullable

The form the person submitted (signup): it joins the open session's events once per name and becomes the fact website_form_submitted.

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

Changes

No recorded changes to this operation across all 1 revision of this API.