v2

latestOpenAPI 3.1.02026-08-07168434918.5 KB
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'

An enumeration.

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

An enumeration.

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.

secret_redactedstring required
idstring required

The unique identifier of the webhook.

game_idstring required

The unique identifier of the game.