Skip to main content

Webhook

1. Overview​

Webhook is a "user-defined HTTP/HTTPS callback" that can be bind to the Actions of Event, which is triggered by Events.

2. Configure Webhook​

You can configure Webhook on web portal as below.

image-20210420144247248

  • Add Webhook: You can click on the +Add Webhook button to add a webhook.

  • Modify Webhook: You can click on the name of a webhook to modify it.

  • Delete Webhook: You can click on the x to delete a webhook.

When you add or modify a webhook, you will enter the following page.

image-20210420144750178

You can input or edit the name, URL and description of the webook in the page.

3. Data Schema​

All Event Data Schema is defined in the doc Extension Data Schema. Here is a sample event_player_login_pgos event. Your Webhook server will receive HTTP body as follows:

// e.g. event_player_login_pgos
{
    "trigger_id": "24ea65b9-a6fb-4de7-9622-410e33c73339",
  "execution_id": "8e03d193bf934f019bd4faadf61541d8",
    "event_name": "event_player_login_pgos",
    "event_time": "1683603150102",
    "event_data": {
        "custom_data": "123",
        "ip_addr": "183.14.133.2",
        "is_new_player": false,
        "location": "-",
        "platform": "WINDOWS",
        "player_id": "123",
        "session_id": "1655777737338073088",
        "start_time": 1683603150
    },
    "args": {
        "arg1": 1
    }
}