benefit.created

Sent when a new benefit is created.

Discord & Slack support: Basic

type

string

required

Allowed value: "benefit.created"

timestamp

string<date-time>

required

data

BenefitCustom · object

required

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

Show child attributes

data.id

string<uuid4>

required

The ID of the benefit.

data.created_at

string<date-time>

required

Creation timestamp of the object.

data.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.type

string

required

Allowed value: "custom"

data.description

string

required

The description of the benefit.

data.selectable

boolean

required

Whether the benefit is selectable when creating a product.

data.deletable

boolean

required

Whether the benefit is deletable.

data.organization_id

string<uuid4>

required

The ID of the organization owning the benefit.

data.metadata

Metadata · object

required

Show child attributes

data.metadata.{key}

data.properties

BenefitCustomProperties · object

required

Properties for a benefit of type custom.

Show child attributes

data.properties.note

string · null · null

required

Private note to be shared with customers who have this benefit granted.

General

Core API

Customer Portal API

Webhook Events

Integrations

benefit.created