Skip to main content

Get Triggers

Provides a list of all active triggers in your gamification system. Triggers are invisible badges used for backend logic, A/B testing, feature unlocking, and risk detection.

Endpoint

GET /v1/admin/triggers

Response

{
"code": 200,
"data": [
{
"uid": "7627f728877c46e196e0197f764811ec",
"label": "Daily Login",
"points": 0,
"description": "Track the login activity of the players and grant random prizes.\r\nBig prizes near-guaranteed at 180th and 365th days.",
"startDate": "2010-01-10T00:00:00",
"endDate": "2040-12-31T00:00:00",
"requiredBadgeUId": null,
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/e269ec9c-3034-4e24-ac10-2b30428d607f_calendar.png",
"isActive": true,
"randomizedPrize": true,
"limited": true,
"type": "Ranked"
},
{
"uid": "547fe3535cb74d9e8018e65e10b7624e",
"label": "Deposit Fail (weekly)",

Response Fields

FieldTypeDescription
uidstringUnique identifier for the trigger
labelstringDisplay name of the trigger
pointsnumberPoints awarded when trigger is activated
descriptionstringDescription of the trigger's purpose
startDatestringISO 8601 timestamp of when the trigger becomes active
endDatestringISO 8601 timestamp of when the trigger expires
requiredBadgeUIdstringUID of badge required before this trigger can activate
imageNamestringURL to the trigger's icon/image
isActivebooleanWhether this trigger is currently active
randomizedPrizebooleanWhether deliverables are randomized
limitedbooleanWhether this trigger has limited activations
typestringTrigger type: OneTimeOnly, Repeatable, or Ranked

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/triggers \
-H "Authorization: Bearer YOUR_API_KEY"

Trigger Types

TypeDescription
OneTimeOnlyActivates only once per player
RepeatableCan activate multiple times
RankedHas multiple levels/ranks

Error Codes

CodeDescriptionResolution
1001Payload is nullCheck request parameters
4001Invalid AuthKeyVerify API key
Learn More

For a deeper understanding of Triggers, see Core Concepts - Badges & Triggers.