Skip to content
Sencai Logo Sencai Logo Sencai Docs

Create a badge-definition

POST
/badge-definitions

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
data
object
code
required

Stable machine-readable identifier referenced by user-rank.badges[].badge_code and gamification-consumer trigger evaluation

string
title
required
string
description
string
icon

Icon name or emoji — no file upload, rendered client-side

string
xp_reward
required
integer
trigger_type
required
string
Allowed values: provisioning_count runbook_success incident_resolved streak_days automation_score_threshold manual_admin_grant
trigger_threshold
integer
active
required
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

object
data
object
code
required

Stable machine-readable identifier referenced by user-rank.badges[].badge_code and gamification-consumer trigger evaluation

string
title
required
string
description
string
icon

Icon name or emoji — no file upload, rendered client-side

string
xp_reward
required
integer
trigger_type
required
string
Allowed values: provisioning_count runbook_success incident_resolved streak_days automation_score_threshold manual_admin_grant
trigger_threshold
integer
active
required
boolean
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

400

Section titled “400 ”

Validation error

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)