Skip to main content
POST
Send a funnel event

Authorizations

Authorization
string
header
required

Store-specific secret generated in Website & sales. Never expose in browser code.

Body

application/json

Name the person with email, emailHash or visitorId; at least one is required. Send email or emailHash, not both. Send valueCents and currency together or not at all.

event
string
required

The event name. 1 to 60 lower-case letters, digits or underscores. The names comment, dm_sent, link_click and store_order are reserved and return 400.

Pattern: ^[a-z0-9_]{1,60}$
Example:

"registered"

email
string<email>

The person's email. SideShift hashes it on arrival, as the browser script does, and does not store it.

Maximum string length: 320
emailHash
string

SHA-256, as 64 lowercase hex characters, of the person's email with leading and trailing spaces removed and made lowercase. The same value window.sideshift.identify sends.

Pattern: ^[0-9a-f]{64}$
visitorId
string

The visitor ID from the SideShift script, from window.sideshift.getVisitorId.

Pattern: ^[a-zA-Z0-9_-]{16,128}$
occurredAt
string<date-time>

When the event happened, as an ISO 8601 time with a UTC offset. Defaults to the time of the request. At most five minutes in the future and at most 90 days in the past.

eventId
string

Your own ID for this event, for safe retries. A repeat for the same store and event name writes nothing. It cannot hold an email address or a phone number.

Required string length: 1 - 200
valueCents
integer

The value of the event in the currency minor unit, despite the Cents suffix. Send it with currency.

Required range: 0 <= x <= 100000000000
currency
string

Supported uppercase ISO 4217 currency code. Send it with valueCents.

Example:

"USD"

Response

Accepted. A repeat of the same eventId for the same store and event returns the first event's ID and writes nothing.

data
object
required