Skip to content
SalesBuilder
Code
See my plan

Event.capture

Records one Event from your Site or product, such as a signup, so every number above can read it.

Action class
None
Approval
Runs on its own
Emits
Event.captured
Price
Free
POST https://api.sb/{your-domain}/events/capture

Its Inputs, Outputs, Effects and guards quote the hub’s Event.capture; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Analytics and experiments.

Inputs

NameTypeMeaning
namestringRequired. The Event name, a Noun and a past-tense Verb, such as Lead.created.
datajsonThe Event’s properties. Optional.
visitorVisitorThe Visitor it happened to, when the person is not known. Optional.

Outputs

FieldTypeWhat null means
eventEventNever null: the captured Event.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Event.captured fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Every Verb emits its own Event, so the registry is the tracking plan.

Emits

Event.captured with { event }

Performed by

Analyst

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Event.captured delivers the result.

You, to your agent
Record that a visitor downloaded the rent-ledger template.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Event.capture",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

Metric.define

Previous

Hypothesis.test

Next