Scopes & fields

Scopes define what an extension may receive. KALYIX separates events from data fields.

Events

An event scope allows a specific event to be delivered.

Scope	Meaning
`event:tip.paid`	A paid tip may be delivered to the extension.

Test events use the same business event type as real tips. This lets you test your alert action with the same variables without creating an entry in the payment history.

Data fields

A field scope allows individual payload fields.

Scope	Field
`field:tip.amount`	Amount.
`field:tip.amountCents`	Amount in cents.
`field:tip.currency`	Currency.
`field:tip.username`	Username.
`field:tip.displayName`	Display name.
`field:tip.message`	Message.
`field:tip.goal`	Goal ID and goal title.
`field:tip.page`	Page slug.

If a data field is not enabled, it is not delivered. If it is enabled but has no value for the event, it may be empty or null.

Example

This selection only delivers amount and currency:

event:tip.paid
field:tip.amount
field:tip.currency

The adapter receives no message, no name, and no goal data.

Adapters

Adapters may rename events so they are easy to use in the target system. Streamer.bot, for example, turns this into:

tip.paid -> kalyix.tip.paid

The permission check happens before that in KALYIX. The adapter only receives the already filtered event.