Allocate game user

This webhook is called when Pley needs to know which Pley game user to use based on a scope user ID. This happens for example when a game is launched.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

New!

Pley is currently experimenting with allowing multi-enviroment testing for the allocate-game-user webhook, so you can see in the release track in the header.

X-Pley-ReleaseTrack is a header with three possible values: production, open-testing or closed-testing depending on which release track the game is currently running on.

This allows you to test the full flow without creating a testing game in the Game Manager by setting up a proxy that forwards requests to the correct enviroment depending on the header values.


Webhook Info
Pley uses the 'Standard Webhook"-specification format.

Webhook Cache
Webhook calls to Pley are cached for 24 hours, meaning Pley does not call the endpoint with the same parameter within 24 hours (caching happens for any 200 OK respose).

Webhook Caching can be disabled in the Game Manager under Release Track -> Webhook. This setting is per release track. Disabling caching on open-testing does not affect the production track.

Body Params
string
required

This webhook's request type. Currently allways "game_user.allocate"

number
required

A UNIX timestamp for when this webhook request was created.

string
required

A unique Identifier for this webhook request. Retries will have the same ID but another timestamp.

data
object
required
Headers
string
required

A copy of the same ID value in the request body. Used in signature validation, and could be used for idempotency.

number
required

A copy of the same timestamp value in the request body. Used in signature validation.

string
required

The signature of this request. Created with a HMAC signature secret provided to you.

Response

Language
URL
LoadingLoading…
Response
Choose an example:
application/json