Developer documentation

Benefits

Benefits describe the limited value your application protects. Policies decide whether a claim is eligible.

Create and assign

Create a stable benefit key, eligibility period, outcome behavior, optional valuation, assigned policy, and enforcement mode. The key is part of your server integration and should not change.

Delete permanently

Deleting a benefit stops new evaluations immediately and permanently removes its setup and exceptions. Past evaluations and usage remain as read-only history. A later benefit may reuse the key without joining the old history.

Live changes

Live writes require the benefits:write scope and current publish_live permission. Use revision to prevent an update from overwriting a newer dashboard or API change.