FINGI API webhooks

To understand how to start using FINGI API, please address following sections of our documentation:
1. How to use FINGI API
2. How to Create App
3. How to Get API Key
4. FINGI API endpoints

FINGI webhooks offer a seamless solution for syncing virtual assets between in-game inventories and the FINGI platform. By automatically sending real-time notifications whenever a change occurs in a user's inventory, webhooks ensure that asset information remains up-to-date and consistent across both environments. This approach eliminates the need for manual synchronization or constant polling, thereby reducing the workload on game servers and enhancing the overall user experience.

Activate Webhooks in the Manage Apps panel.

1. Navigate to the Manage Apps section
2. Click the "Edit" button on the registered app
3. Locate the "Your unique URL for events (FINGI webhook)" field at the bottom
4. Paste the URL that will receive FINGI webhook requests for this app
5. Click 'Save' button

Webhook request

Once you provide a URL for a webhook in the Manage Apps section, this URL will begin receiving HTTP POST requests whenever a user interacts with their inventory on the FINGI platform. The structure and content of these requests will vary depending on the type of interaction, such as merging or selling spendable assets, acquiring or selling permanent items, or activating time-limited items.

Request structure

Webhook: ItemMergeRequested

The ItemMergeRequested webhook is triggered when a user requests to merge items in their FINGI inventory, which means that we should add these items to their in-game inventory.

ItemMergeRequestedContent

The webhook ItemMergeRequested example

{
  "clientId": "123456",
  "event": "ItemMergeRequested",
  "mergeRequest": {
    "mergeId": "abcd1234",
    "userEmail": "[email protected]",
    "itemUri": "https://example-game.example-domain.com/item?id=567890",
    "count": 5
  }
}

Webhook: SellOrderCreated

The SellOrderCreated webhook is triggered when a user creates a sell or minting order for their items in the FINGI inventory.

SellOrderCreatedContent

The webhook SellOrderCreated example

{
  "clientId": "123456",
  "event": "SellOrderCreated",
  "sellOrderCreated": {
    "userEmail": "[email protected]",
    "itemUri": "https://example-game.example-domain.com/item?id=567890",
    "countSold": 3,
    "countRemaining": 2
  }
}

Webhook: TokenAmountChanged

The TokenAmountChanged webhook is triggered when the amount of permanent tokens in a user's inventory changes due to acquiring, selling, or transferring tokens.

TokenAmountChangedContent

SimpleItemInfo

The webhook TokenAmountChanged example

  {
    "clientId": "123",
    "event": "TokenAmountChanged",
    "tokenAmountChanged": {
      "userEmail": "[email protected]",
      "items": [
        {
          "itemUri": "https://sample-game.example.com/item?id=123123",
          "tokenCount": 361
        },
        {
          "itemUri": "https://sample-game.example.com/item?id=123",
          "tokenCount": 253
        },
        {
          "itemUri": "https://sample-game.example.com/item?id=15",
          "tokenCount": 716
        },
        ...
      ]
    }
  }

Webhook: SubActivated

The SubActivated webhook is triggered when a user activates a time-limited token, which extends the expiration time of a time-limited item such as a booster or subscription.

SubActivatedContent

SubActivatedInfo

The webhook SubActivated example

  {
    "clientId": "123",
    "event": "SubActivated",
    "subActivated": {
      "userEmail": "[email protected]",
      "activeSubs": [
        {
          "itemUri": "https://sample-game.example.com/item?id=123",
          "expirationDate": 1975000000,
          "isActive": true
        },
        {
          "itemUri": "https://sample-game.example.com/item?id=456",
          "expirationDate": 1980000000,
          "isActive": true
        },
        ...
      ]
    }
  }