Skip to main content
POST
/
v1
/
renders
/
{id}
/
events
Record a partner-side engagement event
curl --request POST \
  --url https://api.craftkit.dev/v1/renders/{id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "downloaded",
  "metadata": {
    "surface": "dashboard"
  }
}
'
{
  "recorded": true
}

Authorizations

​
Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Path Parameters

​
id
string<uuid>
required

The render id.

Body

application/json
​
eventType
enum<string>
required
Available options:
viewed,
downloaded,
printed
​
metadata
object

Response

Event recorded flag (false when deduped).

​
recorded
boolean
required