Integrate FairPlay with Polar

The Polar integration handles flag events. Transaction provider selection is configured separately in transaction.yml.

Polar flag events and transaction sync

FairPlay can receive Polar flag events through its polar entry in hooks.yml. Configure transaction synchronization separately in transaction.yml; the flag hook does not select a transaction provider.

Install Polar and follow its documentation for the event API required by this integration. Check the integration entry and your server log if alerts do not appear.

Prerequisites

Prerequisites
PrerequisiteWhat to check
Hook entryThe polar entry in generated hooks.yml owns this integration; review its enabled flag in the generated file rather than assuming it is on.
Required event APIInstall Polar and confirm its documentation describes the event API used by this integration.
Transaction settingSet transaction provider options separately in transaction.yml; this flag hook does not configure synchronization.

Configure the hooks.yml entry

Open hooks.yml and locate the polar entry. Use the key spelling and values shown in your generated file.

  • Generated entry: plugin-name: PolarLoader and blacklisted-checks: []. Check your current hooks.yml before editing.
  1. Confirm the plugin-name value reads PolarLoader and compare the event-classes list with the event API required by your installed Polar release.
  2. Review blacklisted-checks, which defaults to an empty list; any entry there excludes that check from this hook.
  3. Review notification-cooldowns, whose default entry is 10000, plus event-priority with default MONITOR and ignore-cancelled-events with default false.
  4. Review the triggers list in the generated polar entry. Review Polar's alert output to confirm the integration is active.
  5. Confirm enabled, notifications-enabled, debug, and verbose-debug reflect the intended policy; leave the punishments subfields (notify, command, increase-reach, cancel-hits) at generated values unless the operator owns the change.

If the hook stays silent

If the hook stays silent
CauseAction
PolarLoader absent API unavailableInstall the Polar release using its documentation and confirm the required event API is available; the hook needs that API to receive events.
event-classes edited to a wrong nameRestore the generated values and check the generated file for the expected key names.
Check excluded via blacklisted-checksRemove the entry or keep the exclusion as an explicit policy decision.
Staff messages throttled by notification-cooldownsAllow for the 10000 default window and compare against the deployed value; throttled output does not mean accounting stopped.
Expecting transaction sync from the flag hookConfigure the provider separately under transaction configuration; the flag hook never selects it.
Browse all documentation