Skip to main content

Vendor Event

  • Alert key: obs-vendorEvent
  • Source: OBS

Default message template​

OBS vendor event

Template variables​

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{eventType}}data.extraSettings.eventType(OBS) The event type of the vendor alert
{{eventData}}data.extraSettings.eventData(OBS) The raw JSON event data from the vendor alert. This data is spread to other variables. So if the eventData has path in it then you can access it with {{path}}
{{vendorName}}data.extraSettings.vendorName(OBS) The name of the third party vendor

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Vendor event is equal to
  • EQUAL_VARIABLE