Integrate FairPlay with Vulcan
The Vulcan integration handles external flag events. Transaction provider selection is configured separately in transaction.yml.
Official links
Vulcan flag events and transaction sync
FairPlay can receive Vulcan flag events through its vulcan entry in hooks.yml. Configure transaction synchronization separately in transaction.yml; the flag hook does not select a transaction provider.
Install Vulcan 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
| Prerequisite | What to check |
|---|---|
| Hook entry | The vulcan entry in generated hooks.yml owns this integration; review its enabled flag in the generated file rather than assuming it is on. |
| Required event API | Install Vulcan and confirm its documentation describes the event API used by this integration. |
| Transaction setting | Set 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 vulcan entry. Use the key spelling and values shown in your generated file.
- Generated entry:
plugin-name: Vulcanandblacklisted-checks: []. Check your currenthooks.ymlbefore editing.
- Confirm the
plugin-namevalue readsVulcanand compare theevent-classeslist with the event API required by your installed Vulcan release. - Review
blacklisted-checks, which defaults to an empty list; any entry there excludes that check from this hook. - Review
notification-cooldowns, whose default entry is 10000, plusevent-prioritywith defaultMONITORandignore-cancelled-eventswith default false. - Review the
triggerslist in the generatedvulcanentry. Review Vulcan's alert output to confirm the integration is active. - Confirm
enabled,notifications-enabled,debug, andverbose-debugreflect the intended policy; leave thepunishmentssubfields (notify,command,increase-reach,cancel-hits) at generated values unless the operator owns the change.
If the hook stays silent
| Cause | Action |
|---|---|
| Vulcan absent API unavailable | Install the Vulcan 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 name | Restore the generated values and check the generated file for the expected key names. |
Check excluded via blacklisted-checks | Remove the entry or keep the exclusion as an explicit policy decision. |
Staff messages throttled by notification-cooldowns | Allow for the 10000 default window and compare against the deployed value; throttled output does not mean accounting stopped. |
| Expecting transaction sync from the flag hook | Configure the provider separately under transaction configuration; the flag hook never selects it. |