Skip to navigation

Post what the user did

At most 50 events. Each is checked on its own; refused ones come back by index. Moves guide progress (guide.completed is sent once, when the last step is done) and the page map’s health. The unload beacon may send the key as ?key= or a body key, with a text/plain body.

A publishable key (Authorization: Bearer rydhm_pk_…), from one of the key’s allowed websites: the Origin header must be on its list. Never a secret API key (401 secret_key_not_allowed). Rate limited per visitor and per key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
eventslist of objectsRequired
userobjectOptional

Who the page’s user is. id with hash (hex HMAC-SHA256 of id under your workspace’s user-signing secret, computed on your server) is a signed user; id alone, or anonymousId, is stored as anon_ and the id.

keystringOptional

The publishable key, only on the page’s unload beacon (text/plain body; also accepted as ?key=).

Response

OK
acceptedinteger
rejectedlist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error