stuk-donation-tracker.json

Schema

The settings for either of the following objects are required if stuk-nodecg.json: omnibar.tracker = "tiltify" OR "gdq".

• tiltify Object Tiltify integration settings. See Tiltify Integration Setup for details.

  • clientID String A Tiltify application client ID.

  • clientSecret String A Tiltify application client secret.

  • campaign_id String A Tiltify campaign ID.

  • webhook_id String A Tiltify application webhook ID.

  • webhook_secret String A Tilitfy application webhook secret.

• gdqTracker Object GDQ Tracker settings, for receiving data from your own GDQ Tracker instance. Building a GDQ Tracker instance is outside of the scope of this package. You can build an instance of the GDQ Tracker from the GamesDoneQuick/donation-tracker GitHub repo. 

  • url String The public, base URL of your of your GDQ Tracker instance. For example, GDQ's own tracker instance is https://tracker.gamesdonequick.com.

  • event_id String The ID of the event you want data for. For example, Summer Games Done Quick 2023's event id is 43. 

Tiltify Integration Setup

Unlike the GDQ Tracker, Tiltify's API isn't public, so you'll need to create an application on Tiltify that you'll link to NodeCG. You should do this after you've set up your Tiltify campaign.

1. Create a new Application on your Tiltify Developer Hub.

2. Give it a suitable name and set the Redirect URI to https://{YOUR_DEPLOYMENT_URL_HERE}/ (see the first image below). If testing locally, this will be http://localhost:9092/.

3. Copy your Client ID and Client Secret and paste them into the tiltify.client_id & tiltify.client_secret respective entries in the config file.

4. Go to the Webhooks menu and add a webhook:

   • Set the Endpoint URL to https://{YOUR_DEPLOYMENT_URL_HERE}/stuk-donation-tracker/webhook

   • Copy the Webhook Signing ID and paste it into the tiltify.webhook_secret entry in the config file

   • Copy the second UUID from the Tiltify Webhook page's URL in your browser (see the green highlighted area in the second image below) and paste it into the tiltify.webhook_id entry in the config file 

5. Get your Tiltify Campaign's campaign ID from the Tiltify Fundraiser Dashboard: select your campaign, go to the Setup menu, the Information header, and copy your campaign's ID (see the third image below):

   • Paste the campaign ID into the tiltify.campaign_id entry in the config file.

   • On your Tiltify Webhook, go to the Subscriptions header, add a new event and paste your campaign ID (see the fourth image below). In the options that appear, enable the Campaign direct:fact_updated toggle and tick Include private data. Then click Create event.