Skip to content

RubyPlay Game Events API

Overview

Game Events are predefined in-game actions or outcomes. These events represent specific occurrences during gameplay (e.g., triggering a feature, hitting a win condition, collecting symbols) and are standardized across games to ensure consistent scoring logic.

See Supported Game Events for the full list of available events and what each one represents.

The Game Events API lets your system receive these events in real time. You subscribe to the event types you care about for specific games, and whenever a matching event occurs during play, a notification is delivered to your configured endpoint, letting you react to player activity as it happens.

How It Works

  1. Subscribe: Configure which game events you want to receive for specific games
  2. Receive: Get real-time webhook notifications when subscribed events occur
  3. Process: Handle incoming webhook payloads in your system

Managing Your Webhook Subscriptions

Subscriptions are managed through the RubyPlay Public API. Use these endpoints to configure which game events you want to receive as webhooks.

MethodEndpointDescription
PUT/api/v1/subscriptions/game-action-eventsCreate or update subscriptions
GET/api/v1/subscriptions/game-action-eventsView your current subscriptions
DELETE/api/v1/subscriptions/game-action-eventsRemove all subscriptions
Subscription_Management.png

Implementing Your Webhook Endpoint

To receive events, your system must expose an HTTPS endpoint that accepts our webhook deliveries. See Implementing Your Webhook Endpoint for endpoint requirements, payload structure, response handling, and delivery and retry behavior.


How Events Become Webhooks

When players interact with games, events are automatically processed and converted into webhook deliveries.

Event_Processing.png

What Events Can You Receive?

The system checks three criteria before sending webhooks:

  1. Your Access: You must have access to the specific game
  2. Your Subscription: You must be subscribed to the event type for that game
  3. Game Configuration: The game must have webhook events enabled

Complete Integration Flow

Complete_Integration_Flow.png

Getting Started

  1. Set up your webhook endpoint to receive POST requests (see Implementing Your Webhook Endpoint)
  2. Test your endpoint returns 200 OK for valid payloads
  3. Contact support to get your brand credentials and available games/events
  4. Create subscriptions using the API for games and events you want to monitor
  5. Monitor incoming webhooks and handle them in your system