Skip to main content

Trigger Details

Provides detailed information for a specific trigger by its unique identifier, including all associated deliverables and prize configurations.

Endpoint

GET /v1/admin/triggers/{triggerID}

Path Parameters

ParameterTypeRequiredDescription
triggerIDstringYesUnique identifier for the trigger

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",
"deliverables": [
{
"label": "Spin Credit",
"uid": "13f1b67e57a548f8bd73e947c3564b90",
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/20b19c63-15d6-4621-a8ab-99b70a239ad6_spin.png",
"amount": 2,
"type": "Prize"
},
{

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
deliverablesarrayList of deliverables issued when trigger activates

Request Example

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

Use Cases

  • Deliverable Analysis: Inspect all prizes and notifications for a trigger
  • Randomized Prize Configuration: Check if trigger uses random reward selection
  • Trigger Prerequisites: Verify if trigger requires specific badges

Trigger Configuration Patterns

Risk Detection

// Fraud detection trigger
{
"label": "Deposit Fail (daily)",
"randomizedPrize": false,
"deliverables": [
{
"label": "System Notification",
"type": "Notification"
}
]
}

Daily Rewards

// Daily login rewards
{
"label": "Daily Login",
"randomizedPrize": true,
"limited": true,
"type": "Ranked",
"deliverables": [ /* random prizes */ ]
}

Feature Unlock

// A/B testing trigger
{
"label": "A/B Testing: Chat feature",
"deliverables": [
{
"label": "Unlock chat feature",
"type": "Notification"
}
]
}

Error Codes

CodeDescriptionResolution
1001Payload is nullCheck path parameters
4001Invalid AuthKeyVerify API key
9005Trigger does not existUse valid triggerId
Related Endpoints