Skip to main content

Webhooks

Webhooks can be used alongside our API and are useful for gaining real-time insights in to XP and currency earnings.

To get started, head over to Settings > Integrations in the On3 Admin panel and enter your Webhook URL.

Event types​

We currently only support the below events. If you need something specific for your use case then please contact us.

EventDescription
XPRecevied when a users XP balances changes
CURRENCYRecevied when a users CURRENCY (either points or tokens) balance changes
note

Events may be batched for efficiency reasons, i.e., we will wait and batch changes for up to 30 seconds before sending to your webhook.

XP​

{
    "kind": "XP",
    "events": [
        {
            "address": "string", // address of the user 
            "xpSeason": "integer", // season the XP was earned in
            "xpRewarded" : "integer",
            "oldSeasonXp": "integer",
            "newSeasonXp": "integer",
            "oldGlobalXp": "integer",
            "newGlobalXp": "integer"
        }
    ]
}

CURRENCY​

{
    "kind": "CURRENCY",
    "events": [
        {
            "address": "string", // address of the user 
            "currencyId": "string", // guid matching an On3 currency ID
            "amountRewarded" : "decimal",
            "oldBalance": "decimal",
            "newBalance": "decimal"
        }
    ]
}