Eventos de Webhook

Esta seção descreve a lista de eventos disponíveis e a estrutura de carga útil por solicitação.

Estrutura da Solicitação de Webhook

Quando nossa plataforma gera uma solicitação de webhook, ela envia uma carga útil estruturada contendo vários eventos. Cada evento consiste em campos específicos que descrevem a natureza do evento, os dados relevantes e a hora em que ocorreu. Abaixo está uma análise detalhada da estrutura do evento de webhook:

{
  "events": [
    {
      "eventName": "string",
      "payload": [
        {
          "key": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "eventDate": "string"
    }
  ]
}

Estrutura do Objeto de Evento

Cada evento na matriz de eventos contém os seguintes campos:

• eventName: Uma string que indica o tipo de evento. Exemplos incluem virtualCurrency_on_walletUpdate, ranks_on_xpUp, level_up, etc.
• payload: Uma matriz de pares chave-valor que fornecem informações detalhadas relacionadas ao evento. Cada item no payload inclui:
  • type: O tipo de dados do valor (disponível: string, number, boolean, i18n e date).
  • key: O nome do campo de dados (por exemplo, PlayerId, Balance, XpBalance).
  • value: O valor associado à chave. Isso retorna a representação de string do tipo de dados.
• eventDate: Uma string de data ISO representando a data e hora em que o evento ocorreu.

Tipos de Item de Carga Útil

Cada item de carga útil pode ter um dos seguintes tipos:

• string: Representa dados de texto.
• number: Representa dados numéricos.
• boolean: Representa dados booleanos.
• i18n: Representa texto internacionalizado com traduções para diferentes idiomas.
• date: Representa data e hora no formato ISO 8601.

Exemplo de Objeto de Evento

{
  "eventName": "level_up",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "9"
    },
    {
      "type": "i18n",
      "key": "RewardExternalDescription",
      "value": {
        "languages": [
          { "language": "EN", "value": "100 Coins" },
          { "language": "IT", "value": "100 Coins" },
          { "language": "FR", "value": "100 Coins" },
          { "language": "DE", "value": "100 Coins" }
        ]
      }
    },
    {
      "type": "number",
      "key": "RemainingPendingLevels",
      "value": "8"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Member"
    },
    {
      "type": "i18n",
      "key": "CurrentRankExternalDescription",
      "value": {
        "languages": [
          { "language": "en", "value": "Member" },
          { "language": "IT", "value": "Member" },
          { "language": "FR", "value": "Member" },
          { "language": "DE", "value": "Member" }
        ]
      }
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "5000.00"
    },
    {
      "type": "boolean",
      "key": "Active",
      "value": "true"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-24T21:28:41.938Z"
    }
  ],
  "eventDate": "2024-06-24T21:28:41.939Z"
}

Lista de Eventos

Cancelamento da Gamificação

Este evento é disparado quando um jogador desativa todos os recursos de fidelidade, escolhendo sair.

Nome do evento: gamification_optout

Exibir detalhes do evento

{
  "playerId": "b9ee09af-4e40-4844-9b68-a72601d5d597",
  "eventName": "gamification_optout",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "b9ee09af-4e40-4844-9b68-a72601d5d597"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-25T17:41:25.613Z"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "1"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Membro"
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "0.00"
    }
  ],
  "eventDate": "2024-06-25T17:41:25.613Z"
}

Ativação da gamificação

Este evento é disparado quando um jogador ativa todos os recursos de fidelidade, escolhendo se cadastrar.

Nome do evento: gamification_optin

Exibir detalhes do evento

{
  "playerId": "b9ee09af-4e40-4844-9b68-a72601d5d597",
  "eventName": "gamification_optin",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "b9ee09af-4e40-4844-9b68-a72601d5d597"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-25T17:41:29.058Z"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "1"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Membro"
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "0.00"
    }
  ],
  "eventDate": "2024-06-25T17:41:29.059Z"
}

Subida de nível

Este evento é acionado quando um requisito de nível é concluído.

Nome do evento: level_up

Exibir detalhes do evento

{
  "playerId": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9",
  "eventName": "level_up",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "9"
    },
    {
      "type": "i18n",
      "key": "RewardExternalDescription",
      "value": {
        "languages": [
          {
            "language": "EN",
            "value": "100 Coins"
          },
          {
            "language": "ES",
            "value": "100 Monedas"
          }
        ]
      }
    },
    {
      "type": "number",
      "key": "RemainingPendingLevels",
      "value": "8"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Membro"
    },
    {
      "type": "i18n",
      "key": "CurrentRankExternalDescription",
      "value": {
        "languages": [
          {
            "language": "en",
            "value": "Member"
          },
          {
            "language": "IT",
            "value": "Member"
          },
          {
            "language": "FR",
            "value": "Member"
          },
          {
            "language": "DE",
            "value": "Member"
          }
        ]
      }
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "5000.00"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-24T21:28:41.938Z"
    }
  ],
  "eventDate": "2024-06-24T21:28:41.939Z"
}

Subir de rank

Este evento é acionado quando todos os níveis em um Rank são concluídos e os requisitos de um Rank são concluídos.

Nome do evento: rank_up

Exibir detalhes do evento

{
  "playerId": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9",
  "eventName": "rank_up",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "19"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Prata"
    },
    {
      "type": "i18n",
      "key": "CurrentRankExternalDescription",
      "value": {
        "languages": [
          {
            "language": "pt-BR",
            "value": "Prata"
          }
        ]
      }
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "18250.00"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-24T21:28:42.899Z"
    }
  ],
  "eventDate": "2024-06-24T21:28:42.899Z"
}

Rebaixamento do jogador

Este evento é acionado sempre que um jogador é rebaixado.

Nome do evento: on_player_downgrade

Exibir detalhes do evento

{
  "playerId": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9",
  "eventName": "rank_up",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "PreviousLevel",
      "value": "19"
    },
    {
      "type": "number",
      "key": "CurrentLevel",
      "value": "1"
    },
    {
      "type": "string",
      "key": "CurrentRankExternalName",
      "value": "Prata"
    },
    {
      "type": "string",
      "key": "PreviousRankExternalName",
      "value": "Ouro"
    },
    {
      "type": "number",
      "key": "PreviousXpBalance",
      "value": "18250.00"
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "10.00"
    },
    {
      "type": "number",
      "key": "PreviousTokensBalance",
      "value": "2789.00"
    },
    {
      "type": "number",
      "key": "TokensBalance",
      "value": "1.00"
    },
    {
      "type": "date",
      "key": "Timestamp",
      "value": "2024-06-24T21:28:42.899Z"
    }
  ],
  "eventDate": "2024-06-24T21:28:42.899Z"
}

Missão concluída

Este evento é acionado quando uma Missão é concluída.

Nome do evento: mission_completed

Exibir detalhes do evento

{
  "playerId": "b9ee09af-4e40-4844-9b68-a72601d5d597",
  "eventName": "mission_completed",
  "payload": [
    {
      "key": "PlayerId",
      "type": "string",
      "value": "b9ee09af-4e40-4844-9b68-a72601d5d597"
    },
    {
      "key": "RewardExternalName",
      "type": "i18n",
      "value": {
        "languages": []
      }
    },
    {
      "key": "RemainingPendingMissions",
      "type": "number",
      "value": "6"
    },
    {
      "key": "MissionBundleExternalName",
      "type": "i18n",
      "value": {
        "languages": [
          {
            "language": "pt-BR",
            "value": "Missão Um"
          }
        ]
      }
    }
  ],
  "eventDate": "2024-06-25T17:38:11.881Z"
}

Pacote de missão concluído

Este evento é acionado quando um Pacote de Missão é concluído e todas as Missões pertinentes dentro dele são concluídas.

Nome do evento: mission_bundle_completed

Exibir detalhes do evento

{
  "playerId": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9",
  "eventName": "mission_bundle_completed",
  "payload": [
    {
      "key": "PlayerId",
      "type": "string",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "key": "MissionBundleExternalName",
      "type": "i18n",
      "value": {
        "languages": []
      }
    }
  ],
  "eventDate": "2024-06-25T15:00:35.954Z"
}

Pontos de Nível de Classificação Atualizados

Este evento é enviado quando o jogador é creditado com Pontos XP

Nome do evento: ranks_on_xpUp

Exibir detalhes do evento

{
  "eventName": "ranks_on_xpUp",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "XpBalance",
      "value": "5000"
    },
    {
      "type": "number",
      "key": "PointsUntilNextLevel",
      "value": "-4900"
    },
    {
      "type": "number",
      "key": "PointsUntilNextRank",
      "value": "10000"
    }
  ],
  "eventDate": "2024-06-25T15:00:35.954Z"
}

Saldo de Tokens de Moeda Virtual Atualizado

Este evento é disparado quando o jogador é creditado com Moedas de Moeda Virtual

Nome do Evento: virtualCurrency_on_walletUpdate

Exibir detalhes do evento

{
  "eventName": "virtualCurrency_on_walletUpdate",
  "payload": [
    {
      "type": "string",
      "key": "PlayerId",
      "value": "d4a9bbb4-576b-4c29-8f8d-e03c427265c9"
    },
    {
      "type": "number",
      "key": "Balance",
      "value": "5000"
    }
  ],
  "eventDate": "2024-06-25T15:00:35.954Z"
}

Compra de Produto da Loja de Recompensas

Este evento é disparado quando qualquer alteração é realizada para um pedido de produto da loja de recompensas de um jogador. Por exemplo na compra, no envio, no cancelamento, etc.

Nome do Evento: product_purchase

Exibir detalhes do evento

{
  "playerId": "d023aa08-7a3b-462b-b9c3-89cb3a8489b9",
  "eventName": "product_purchase",
  "payload": [
    {
      "key": "PlayerId",
      "value": "d023aa08-7a3b-462b-b9c3-89cb3a8489b9",
      "type": "string"
    },
    {
      "key": "OrderStatus",
      "value": "purchased",
      "displayValue": "Comprado",
      "type": "enum",
      "options": [
        {
          "key": "Cancelled",
          "value": "cancelled"
        },
        {
          "key": "OutOfStock",
          "value": "out_of_stock"
        },
        {
          "key": "Purchased",
          "value": "purchased"
        },
        {
          "key": "Shipped",
          "value": "shipped"
        },
        {
          "key": "ThirdParty",
          "value": "third_party"
        }
      ]
    },
    {
      "key": "ProductExternalName",
      "value": {
        "languages": [
          {
            "language": "PT",
            "value": "(H3) viagem à lua da spaceX"
          }
        ]
      },
      "type": "i18n"
    },
    {
      "key": "ProductExternalDescription",
      "value": {
        "languages": [
          {
            "language": "PT",
            "value": "<p><em>A Lua é um dos vizinhos habitáveis mais próximos da Terra e oferece a oportunidade de adquirir valiosa experiência para missões a Marte e além.</em></p>"
          }
        ]
      },
      "type": "i18n"
    },
    {
      "key": "Quantity",
      "value": "1",
      "type": "number"
    },
    {
      "key": "Price",
      "value": "3",
      "type": "number"
    },
    {
      "key": "RecipientName",
      "value": "João",
      "type": "string"
    },
    {
      "key": "RecipientAddress",
      "value": "Zarcero, 10, Rua, 12345, CR",
      "type": "string"
    },
    {
      "key": "ProductType",
      "value": "external_product",
      "displayValue": "Produto Externo",
      "type": "enum",
      "options": [
        {
          "key": "Bonus",
          "value": "bonus"
        },
        {
          "key": "Booster",
          "value": "booster"
        },
        {
          "key": "ExternalProduct",
          "value": "external_product"
        },
        {
          "key": "XP",
          "value": "xp"
        }
      ]
    },
    {
      "key": "ProductStatus",
      "value": "purchased",
      "displayValue": "Comprado",
      "type": "enum",
      "options": [
        {
          "key": "Cancelled",
          "value": "cancelled"
        },
        {
          "key": "OutOfStock",
          "value": "out_of_stock"
        },
        {
          "key": "Purchased",
          "value": "purchased"
        },
        {
          "key": "Shipped",
          "value": "shipped"
        },
        {
          "key": "ThirdParty",
          "value": "third_party"
        }
      ]
    },
    {
      "key": "TokensBalance",
      "value": "238",
      "type": "number"
    },
    {
      "key": "Timestamp",
      "value": "2024-09-11T17:32:43.224Z",
      "type": "date"
    },
    {
      "key": "ExternalURL",
      "value": "https://www.amazing-fake-shop-store.com/SpaceX-Spacecraft-Astronaut-Desktop-Ornaments/pd/LTGe5ckn23",
      "type": "string"
    },
    {
      "key": "Comment",
      "value": "Recompensa comprada de widgets. ",
      "type": "string"
    },
    {
      "key": "Suppliers",
      "value": "Amazing Fake Store",
      "type": "string"
    },
    {
      "key": "ProductRemainingStock",
      "value": "49",
      "type": "number"
    }
  ],
  "eventDate": "2024-09-11T17:32:43.224Z"
}

Feliz integração!