Webhook notification

When you configure a Bounty endpoint, Nexus sends a notification whenever a creator completes a bounty that includes an external reward. The notification carries information on the reward.

In your program’s Webhooks page, add an endpoint with the Bounty event type. Copy its dedicated signing secret to your receiving server. Bounty notifications use the standard webhook-signature header; a private API key is not required to verify them.

See Webhooks for detailed information on Nexus webhooks.

Bounty reward notifications

A bounty reward notification has an eventType of Bounty and an eventAction of BountyReward. Its event data looks like this:

{
    "attributionGroupId": "B8b84wld-ohveWtgQPJsS",
    "attributionGroupName": "Great Game",
    "creatorId": "9jd7RBR_B2BZ0uWO3_lgv",
    "bountyId": "tzPlV9PeX9Tsxg158pZ47",
    "bountyName": "Refer 5 Players",
    "bountyProgressId": "4a3C8DLDjPToZ_BMRrYXx",
    "playerId": "55d57cffaa074cc6b8d332f5d77661f2",
    "bountyRewards": [
        {
            "id": "prYjeQugJG1n8qFCjW2rM",
            "name": "In Game Title",
            "amount": 1,
            "externalId": "dalfjkAsdlgJkdal",
            "creatorRewardId": "PDKczbm3bmNFZWcrelC5N"
        }
    ]
}

playerId is the unique identifier you mapped to this creator when they linked with your Referral Program. If the notification omits playerId, this creator has not yet linked their Nexus account with your referral group. See Generating codes for your program and Linking to an existing Nexus to resolve this.

Each bounty reward includes the externalId you provided, which should map to the reward in your system.

Once you process a reward, mark it complete with its creatorRewardId.