Forge HQ React SDK

This SDK provides basic functions to embed Forge HQ.

Installation

To install the SDK, use npm or yarn:

npm install @forgehq/react-forge-js

Be aware that the SDK may be provided as a private package in other NPM registries or using different package names.

Usage

Importing the SDK

import { launchDedicatedQuestPage } from '@forgehq/react-forge-js';

Functions

launchDedicatedQuestPage

Redirects the user to the ForgeHQ

Parameters:

• questId (string): The quest id you want to deep link into.
• partnerId (string): Your Forge partner id.
• partnerToken (string): Your system user token
• returnUrl (string): The URL to redirect after the work is done.

Example:

launchDedicatedQuestPage(
  'link_twitter_account',
  'rochambeau',
  'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0ZWY5ZGYxMS0yMDI0LTQzN2UtYTNlNS04MmNiYjhiYzRhNjEiLCJpYXQiOjE3MzI2ODk3MDUsImV4cCI6MTczMjc3NjEwNX0.i6Z3WOevVT7CVc5Ms_3PgVgr8nIgu-sxPfcUK0tg8MD5KqHsPNlDIPhZ714BGUl5f3XBAnch5k8spGSzaaxeAgtygsE3fEVg2-wBiR6Yqy30rV7af6DVXG9jVg-bEyWMbZNRFFJmUyZhxdRBWRRVPG5SFJVqo1eReKPWlHSa4R77jvWCO9m-',
  'https://playrochambeau.com/'
);

fetchUserQuests

Retrieves list of quests

Parameters:

• campaignId (string): Your Forge campaign id.
• partnerToken (string): Your system user token.
• partnerId (string): Your Forge partner id.

Example:

fetchUserQuests(
  'rochambeau-1Xf28dfha23821e',
  'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0ZWY5ZGYxMS0yMDI0LTQzN2UtYTNlNS04MmNiYjhiYzRhNjEiLCJpYXQiOjE3MzI2ODk3MDUsImV4cCI6MTczMjc3NjEwNX0.i6Z3WOevVT7CVc5Ms_3PgVgr8nIgu-sxPfcUK0tg8MD5KqHsPNlDIPhZ714BGUl5f3XBAnch5k8spGSzaaxeAgtygsE3fEVg2-wBiR6Yqy30rV7af6DVXG9jVg-bEyWMbZNRFFJmUyZhxdRBWRRVPG5SFJVqo1eReKPWlHSa4R77jvWCO9m-',
  'rochambeau',
);