Scopes & Datenfelder

Scopes bestimmen, was eine Extension bekommen darf. KALYIX trennt dabei Ereignisse und Datenfelder.

Ereignisse

Ein Event-Scope erlaubt, dass ein bestimmtes Ereignis ausgeliefert werden darf.

Scope	Bedeutung
`event:tip.paid`	Ein bezahlter Tip darf an die Extension geliefert werden.

Test-Events nutzen denselben fachlichen Event-Typ wie echte Tips. Dadurch kannst du deine Alert-Action mit denselben Variablen testen, ohne einen Eintrag in der Zahlungshistory zu erzeugen.

Datenfelder

Ein Field-Scope erlaubt einzelne Felder im Payload.

Scope	Feld
`field:tip.amount`	Betrag.
`field:tip.amountCents`	Betrag in Cent.
`field:tip.currency`	Währung.
`field:tip.username`	Nutzername.
`field:tip.displayName`	Anzeigename.
`field:tip.message`	Nachricht.
`field:tip.goal`	Goal-ID und Goal-Titel.
`field:tip.page`	Page-Slug.

Wenn ein Datenfeld nicht aktiv ist, wird es nicht ausgeliefert. Wenn es aktiv ist, aber beim Event keinen Wert hat, kann es leer oder null sein.

Beispiel

Diese Auswahl liefert nur Betrag und Währung:

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

Der Adapter bekommt dann keine Nachricht, keinen Namen und keine Goal-Daten.

Adapter

Adapter dürfen Events umbenennen, damit sie im Zielsystem gut nutzbar sind. Streamer.bot macht daraus zum Beispiel:

tip.paid -> kalyix.tip.paid

Die Berechtigungsprüfung passiert vorher in KALYIX. Der Adapter erhält nur das bereits gefilterte Event.