Webhooks

Update Webhook

Changed on

Updates a webhook.

put/v1/webhooks/{webhook_id}

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/webhooks/{webhook_id}
  • Auth
    HTTP bearer

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

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

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