Pterodactyl WebSocket TriggerInstall

Summary

Listen for real-time events from a specified Pterodactyl server via WebSocket, triggering workflows on selected event types such as console output, server status changes, resource stats, or daemon messages.

Inputs

• serverId (required) — Select the Pterodactyl server to monitor by its identifier.
• events (required) — Choose one or more event types to trigger the workflow on, including all events or specific categories like console output, status, stats, and daemon messages.
• options — Configure behavior options such as inclusion of raw WebSocket data, event batching (throttling) settings to control event emission frequency and batch size, discard excess event behavior, and automatic reconnection with maximum attempts on connection loss.

Output shape

a list of event objects each containing JSON with event name, timestamp, server ID, event-specific data, and optionally raw WebSocket message data

Events are emitted either individually or batched depending on options. Event batching reduces workflow executions by grouping multiple events emitted within configurable intervals and batch sizes. The output includes a 'json' property with event details; raw WebSocket data is included if enabled. Connection loss triggers reconnection attempts per options, with errors logged.