{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"RubyPlay Game Events API"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"rubyplay-game-events-api","__idx":0},"children":["RubyPlay Game Events API"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/game-events/supported-events"},"children":["Supported Game Events"]}," for the full list of available events and what each one represents."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":2},"children":["How It Works"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Subscribe"]},": Configure which game events you want to receive for specific games"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Receive"]},": Get real-time webhook notifications when subscribed events occur"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Process"]},": Handle incoming webhook payloads in your system"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"managing-your-webhook-subscriptions","__idx":3},"children":["Managing Your Webhook Subscriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subscriptions are managed through the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/public-api/game-events"},"children":["RubyPlay Public API"]},". Use these endpoints to configure which game events you want to receive as webhooks."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/public-api/game-events/create-update-subscription"},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/subscriptions/game-action-events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create or update subscriptions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/public-api/game-events/get-subscription"},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/subscriptions/game-action-events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View your current subscriptions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/public-api/game-events/delete-subscription"},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/subscriptions/game-action-events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove all subscriptions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/subscription_management.6bfab3783264b818272e950fd55ed1c847be70ab148114a454997ef9427516e5.dde7e6fc.png","alt":"Subscription_Management.png","framed":false,"withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"implementing-your-webhook-endpoint","__idx":4},"children":["Implementing Your Webhook Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To receive events, your system must expose an HTTPS endpoint that accepts our webhook deliveries. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/game-events/webhook-endpoint"},"children":["Implementing Your Webhook Endpoint"]}," for endpoint requirements, payload structure, response handling, and delivery and retry behavior."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-events-become-webhooks","__idx":5},"children":["How Events Become Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When players interact with games, events are automatically processed and converted into webhook deliveries."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/event_processing.dea8986afde65b283e34cba3fb97af5b4d850fe28c81979ac9e8138b0fa90c8a.dde7e6fc.png","alt":"Event_Processing.png","framed":false,"withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-events-can-you-receive","__idx":6},"children":["What Events Can You Receive?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The system checks three criteria before sending webhooks:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Your Access"]},": You must have access to the specific game"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Your Subscription"]},": You must be subscribed to the event type for that game"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Game Configuration"]},": The game must have webhook events enabled"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"complete-integration-flow","__idx":7},"children":["Complete Integration Flow"]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/complete_integration_flow.60edb4dded4f2898f16e0a824373856305aa4cc0fb27844b8be42136d8c77271.dde7e6fc.png","alt":"Complete_Integration_Flow.png","framed":false,"withLightbox":true,"width":"","height":""},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":8},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set up your webhook endpoint"]}," to receive POST requests (see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/content/integration/game-events/webhook-endpoint"},"children":["Implementing Your Webhook Endpoint"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test your endpoint"]}," returns 200 OK for valid payloads"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact support"]}," to get your brand credentials and available games/events"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create subscriptions"]}," using the API for games and events you want to monitor"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor incoming webhooks"]}," and handle them in your system"]}]}]},"headings":[{"value":"RubyPlay Game Events API","id":"rubyplay-game-events-api","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"How It Works","id":"how-it-works","depth":2},{"value":"Managing Your Webhook Subscriptions","id":"managing-your-webhook-subscriptions","depth":2},{"value":"Implementing Your Webhook Endpoint","id":"implementing-your-webhook-endpoint","depth":2},{"value":"How Events Become Webhooks","id":"how-events-become-webhooks","depth":2},{"value":"What Events Can You Receive?","id":"what-events-can-you-receive","depth":3},{"value":"Complete Integration Flow","id":"complete-integration-flow","depth":2},{"value":"Getting Started","id":"getting-started","depth":2}],"frontmatter":{"seo":{"title":"RubyPlay Game Events API"}},"lastModified":"2026-08-11T09:32:41.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/content/integration/game-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}