Webhooks

Get Webhooks

Returns a list of webhooks.

get/v1/webhooks

Query parameters

limitinteger

The limit on the number of objects to be returned

The limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

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.51

    • ●

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

      request-parameter-exclusive-min-set

    • ●

      for the query request parameter limit, the max was set to 300.00

      request-parameter-max-set

    • ●

      for the query request parameter offset, the min was set to 0.00

      request-parameter-min-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