Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Webhooks and event queue

Purpose

A webhook is a signed HTTP request Open Play sends to your own server when an event happens. This page shows the registered endpoints, the attempts to send each event to an endpoint, and the event queue (outbox) waiting to be sent. The page is read-only: there is no button in the panel to add or delete an endpoint, resend a failed delivery or see the secret. Endpoints are registered over REST; for details, see the Webhooks guide.

When to use

  • To verify that your server is receiving webhooks.
  • To understand why an event did not arrive (is it waiting, did it fail, which error).
  • To see whether an endpoint is enabled and which event types it listens to.

Note

If the webhooks module is disabled, the webhook endpoints do not respond (404, module_disabled). Enable the module on the Game settings › Modules page. To see the page, your role also needs webhook read permission.

Step by step

  1. Make sure you selected the right game and environment.
  2. In the “Webhook endpoints” table, check your endpoint’s address (URL), the event types it listens to and its status. If the filter is empty, it says “tümü” (all), which means the endpoint receives all events.
  3. In the “Delivery attempts / DLQ” table, filter deliveries by status. Those that are failed have used up their retries (DLQ, dead letter queue).
  4. In the “Hata” (Error) column you see the class of the error and, if there is one, the HTTP code your server returned. The raw error text is not shown.
  5. In the “Outbox” table you see the events waiting to be sent or being attempted.
  6. Press Yenile (Refresh) to see new data.

Fields and options

There is no form to fill in on this page.

Tables

TableColumns
Webhook endpointsURL, Event filtreleri (Event filters), Durum (Status; enabled or disabled), Oluşturulma (Created); the Endpoint kimliği (Endpoint ID) column is turned on from the column menu
Delivery attempts / DLQEndpoint (URL, delivery ID and event ID), Durum (Status; pending, delivered, failed), Attempt (the number of attempts), Hata (Error), Oluşturma (Created), Teslim (Delivered); the delivery order and outbox ID columns are turned on from the column menu
OutboxEvent (the type and the event ID), Durum (Status), Attempt, Retry (the time of the next attempt), Oluşturma (Created)

For a published (completed) outbox record, the next attempt time shows “—”. If the event type is a hidden internal event, it says “redacted/private”. The panel never shows secrets, the raw body or the raw error text.

Common situations

SituationWhat to do
It says “Webhook yüzeyi yetki gerektiriyor” (The webhook surface needs permission)Your role has no webhook read permission; ask an admin.
The tables are emptyYou may not have registered an endpoint yet; also check that you selected the right environment.
A delivery is “failed”Your server is not returning 2xx or cannot be reached. Look at the class and code in the Hata column; fix your receiver. There is no resend from the panel.
The same event arrived more than onceDelivery happens at least once; your receiver should drop repeats by the event ID. For details, see the guide.
I cannot see an endpoint’s secretThe secret comes back only once, in the registration response; it is not shown anywhere afterwards. To renew it, delete the endpoint and register it again.