Sign in
Webhooks

Create Webhook

Creates a new webhook.

post/v1/webhooks

Request body

eventsWebhookEventType[] required

The list of events that trigger the webhook.

urlstring required

The URL where the webhook will be sent.

descriptionstring nullable

The description of a webhook.

method'GET' | 'POST' required
enabledboolean

The enabled status of the webhook.

enabled_logsboolean

The enabled logs of the webhook.

player_context_enabledboolean nullable

Enable send player attributes in context

batch_modeboolean nullable

Enable batch delivery mode.

Response

Successful Response

eventsWebhookEventType[] required

The list of events that trigger the webhook.

urlstring required

The URL where the webhook will be sent.

descriptionstring nullable

The description of a webhook.

method'GET' | 'POST' required
enabledboolean

The enabled status of the webhook.

enabled_logsboolean

The enabled logs of the webhook.

player_context_enabledboolean nullable

Enable send player attributes in context

batch_modeboolean nullable

Enable batch delivery mode.

idstring required

The unique identifier of the webhook.

game_idstring required

The unique identifier of the game.

secretstring required

The secret used to sign the webhook.

Changes

Changed in 2 of the 28 revisions of this API.22

  • a14f6ce6d18711See the full diff
    • ●

      added the new page.get enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new page.get enum value to the request property /

      request-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fd2c63d975cd11See the full diff
    • ●

      added the new player.update enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new player.update enum value to the request property /

      request-property-enum-value-added