Skip to main content
POST https://api.craftkit.dev/v1/renders/:id/events
Records a partner-side engagement event for a render. Every event written here is stamped actorKind: "partner" — recipient-side viewed/downloaded/printed events are recorded server-side by the public share page, not through this route.

Authorization

string
required
Bearer ck_live_… — a project API key.

Path parameters

string
required
The render id. Must belong to this key’s project.

Body

string
required
One of viewed, downloaded, printed. The other engagement types (email_*, share_*) are recorded by the system, not this route.
object
Optional free-form key/value bag (string keys, any JSON values) stored verbatim with the event.
viewed, downloaded, and printed are deduped within a 5-minute window keyed on (shareId, eventType, sourceIp). A duplicate inside that window returns { "recorded": false } and is not stored.

Response

200 with whether the event was written.
boolean
true if the event was inserted, false if it was deduped within the 5-minute window.

Errors

cURL
200