Webhooks

Create Webhook

Changed on

Creates a new webhook.

post/v1/webhooks

Request

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

Request body

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.

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.

secretstring required

The secret used to sign the webhook.

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

  • a14f6ce6d187Revision changes
    • warning

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

    • info

      added the new page.get enum value to the request property /