Webhooks

Get Webhook

Returns a single webhook.

get/v1/webhooks/{webhook_id}

Path parameters

webhook_idstring required

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.

secret_redactedstring required

Changes

Changed in 4 of the 28 revisions of this API.31

    • ●

      for the path request parameter webhook_id, the maxLength was set to 32

      request-parameter-max-length-set

    • ○

      the response required property became read-only for the status

      response-required-property-became-read-only

    • ●

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

      response-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

    • ●

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

      response-property-enum-value-added