Custom API Task
Overview
The Custom API task in Stiqy enables you to create unique and engaging tasks that leverage external API integrations. With this task, you can validate users' in-game or on-platform engagement. For example, you can verify user activities on your platform or milestones in your game, such as playing a certain number of matches or reaching a specific level.
Note: To implement Custom API tasks, you need to contact our support team first so we can coordinate with your developers.
How to Configure a Custom API Task
Step 1: Access the Task Creation Panel
Navigate to Campaigns:
Log in to your Stiqy Admin dashboard.
Navigate to Campaigns from the left-hand menu.
Select the campaign you want to add the task to, or create a new campaign.
Open the "Tasks" Tab: Click the Tasks tab in the top horizontal menu.
Create a New Task: Click the Create New Task button at the top right of the screen.
Step 2: Create the Custom API Task
In the "Task Types" panel, choose Custom API under the "Custom Tasks" section.
Click Continue to proceed to the task configuration panel.
Step 4: Configure Task Details
Required Fields:
Name: Enter a descriptive name for your task (e.g., "Play 10 matches in our game").
Points: Specify how many points the user will earn upon completing the task.
API Endpoint URL: Enter the URL of the API endpoint you want to connect to.
Note: If you are unsure what the URL of the API endpoint to input, please refer to your developer who created the API for support.
Optional Fields:
Description: Provide clear instructions or context for participants.
Gems: Optionally, add a gem reward.
Start Date and End Date: Define the time period during which the task will be active.
Enable the Sync with Campaign Dates toggle to align the task dates with the campaign dates.
Frequency: Select how often the task can be completed (e.g., Once, Daily, etc.).
Note: The frequency should've been scoped during the creation of the API.
API Auth Method: Choose the method to authenticate users (e.g., Email).
API Query Params: Add any required parameters for the API.
Label: Select an existing label or create a new label to categorize this task.
Minimal Occurrences: Specify the minimum number of occurrences required for task completion.
API Key: If required, provide the API key to access the endpoint.
CTA Button URL: Provide a URL for the action button participants will click.
Step 5: Save the Task
Review all the entered details.
Click Create Task to save and activate the task.
Use Case
Example: Gaming Platform Engagement
Scenario: A gaming platform wants to increase user retention by encouraging players to complete in-game milestones.
Task Setup:
Name: "Reach Level 10 in the Game"
Description: "Achieve level 10 in the game to earn 50 points and a bonus gem reward!"
Points: 50 points
Gems: 5 gems
Start Date and End Date: December 1, 2024, to December 31, 2024
Frequency: Once
API Endpoint URL:
https://api.gamingplatform.com/validate-levelAPI Auth Method: Email
API Query Params:
{ "userId": "user_email", "level": 10 }CTA Button URL:
https://gamingplatform.com/start-now
Troubleshooting Tips
Incorrect API
Double-check the endpoint URL to ensure it is correct.
Verify the entered API Key and parameters.
Authentication Errors:
Ensure the API key and authentication method match the API’s requirements.
Task Not Showing in the User Dashboard:
Check the task's active status in the admin panel.
Verify that you have successfully saved the task.
Video Guide
https://www.loom.com/share/93ed57ad3ffc4cb7959944a0e2fe83ed?sid=8fb168be-6b75-4eec-84c1-59c671842299
Last updated