Sign in
Webhooks

Update Webhook

Updates a webhook.

put/v1/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Request body

eventsWebhookEventType[]

The list of events that trigger the webhook.

urlstring

The URL where the webhook will be sent.

descriptionstring

The description of a webhook.

method'GET' | 'POST'
enabledboolean

The enabled status of the webhook.

enabled_logsboolean

The enabled logs of the webhook.

player_context_enabledboolean nullable

Enable player context.

batch_modeboolean

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.

secret_redactedstring required

Changes

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

  • fb9750c99d0a1See the full diff
    • ●

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

      request-parameter-max-length-set

  • 476c49005e4e1See the full diff
    • ○

      the response required property became read-only for the status

      response-required-property-became-read-only

  • 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