Create points triggers

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const result = await trophy.admin.points.triggers.create('system-uuid', [
  {
    type: 'metric',
    points: 10,
    metricId: 'metric-uuid',
    metricThreshold: 5
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

result = client.admin.points.triggers.create(
  system_id='system-uuid',
  request=[{
    'type': 'metric',
    'points': 10,
    'metric_id': 'metric-uuid',
    'metric_threshold': 5
  }]
)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Admin.Points.Triggers.Create(context.TODO(), "system-uuid", api.CreatePointsTriggersRequest{})

curl --request POST \
  --url https://admin.trophy.so/v1/points/{systemId}/triggers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "type": "metric",
    "points": 10,
    "status": "inactive",
    "userAttributes": [
      {
        "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attributeValue": "<string>"
      }
    ],
    "metricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metricThreshold": 2,
    "eventAttributes": [
      {
        "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attributeValue": "<string>"
      }
    ],
    "achievementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "streakLength": 2,
    "timeInterval": 2,
    "blockIfOutOfPoints": false
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points/{systemId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'type' => 'metric',
        'points' => 10,
        'status' => 'inactive',
        'userAttributes' => [
                [
                                'attributeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'attributeValue' => '<string>'
                ]
        ],
        'metricId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'metricThreshold' => 2,
        'eventAttributes' => [
                [
                                'attributeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'attributeValue' => '<string>'
                ]
        ],
        'achievementId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'streakLength' => 2,
        'timeInterval' => 2,
        'blockIfOutOfPoints' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://admin.trophy.so/v1/points/{systemId}/triggers")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"type\": \"metric\",\n    \"points\": 10,\n    \"status\": \"inactive\",\n    \"userAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"metricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"metricThreshold\": 2,\n    \"eventAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"achievementId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"streakLength\": 2,\n    \"timeInterval\": 2,\n    \"blockIfOutOfPoints\": false\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/points/{systemId}/triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"type\": \"metric\",\n    \"points\": 10,\n    \"status\": \"inactive\",\n    \"userAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"metricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"metricThreshold\": 2,\n    \"eventAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"achievementId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"streakLength\": 2,\n    \"timeInterval\": 2,\n    \"blockIfOutOfPoints\": false\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "created": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "points": 123,
      "userAttributes": [
        {
          "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributeValue": "<string>"
        }
      ],
      "blockIfOutOfPoints": true,
      "metricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metricThreshold": 123,
      "eventAttributes": [
        {
          "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributeValue": "<string>"
        }
      ],
      "achievementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "streakLength": 123,
      "timeInterval": 123
    }
  ],
  "issues": [
    {
      "severity": "warning",
      "message": "Would exceed maximum freeze limit",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "user-123",
      "boostId": "550e8400-e29b-41d4-a716-446655440000",
      "index": 0
    }
  ]
}

{
  "created": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "metric",
      "points": 10,
      "status": "active",
      "userAttributes": [],
      "metricId": "660f9500-f30c-42e5-b827-557766550001",
      "metricThreshold": 5,
      "eventAttributes": [],
      "blockIfOutOfPoints": false
    }
  ],
  "issues": []
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

points

{systemId}

triggers

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const result = await trophy.admin.points.triggers.create('system-uuid', [
  {
    type: 'metric',
    points: 10,
    metricId: 'metric-uuid',
    metricThreshold: 5
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

result = client.admin.points.triggers.create(
  system_id='system-uuid',
  request=[{
    'type': 'metric',
    'points': 10,
    'metric_id': 'metric-uuid',
    'metric_threshold': 5
  }]
)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Admin.Points.Triggers.Create(context.TODO(), "system-uuid", api.CreatePointsTriggersRequest{})

curl --request POST \
  --url https://admin.trophy.so/v1/points/{systemId}/triggers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "type": "metric",
    "points": 10,
    "status": "inactive",
    "userAttributes": [
      {
        "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attributeValue": "<string>"
      }
    ],
    "metricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metricThreshold": 2,
    "eventAttributes": [
      {
        "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attributeValue": "<string>"
      }
    ],
    "achievementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "streakLength": 2,
    "timeInterval": 2,
    "blockIfOutOfPoints": false
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points/{systemId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'type' => 'metric',
        'points' => 10,
        'status' => 'inactive',
        'userAttributes' => [
                [
                                'attributeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'attributeValue' => '<string>'
                ]
        ],
        'metricId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'metricThreshold' => 2,
        'eventAttributes' => [
                [
                                'attributeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'attributeValue' => '<string>'
                ]
        ],
        'achievementId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'streakLength' => 2,
        'timeInterval' => 2,
        'blockIfOutOfPoints' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://admin.trophy.so/v1/points/{systemId}/triggers")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"type\": \"metric\",\n    \"points\": 10,\n    \"status\": \"inactive\",\n    \"userAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"metricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"metricThreshold\": 2,\n    \"eventAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"achievementId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"streakLength\": 2,\n    \"timeInterval\": 2,\n    \"blockIfOutOfPoints\": false\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/points/{systemId}/triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"type\": \"metric\",\n    \"points\": 10,\n    \"status\": \"inactive\",\n    \"userAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"metricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"metricThreshold\": 2,\n    \"eventAttributes\": [\n      {\n        \"attributeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"attributeValue\": \"<string>\"\n      }\n    ],\n    \"achievementId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"streakLength\": 2,\n    \"timeInterval\": 2,\n    \"blockIfOutOfPoints\": false\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "created": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "points": 123,
      "userAttributes": [
        {
          "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributeValue": "<string>"
        }
      ],
      "blockIfOutOfPoints": true,
      "metricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metricThreshold": 123,
      "eventAttributes": [
        {
          "attributeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributeValue": "<string>"
        }
      ],
      "achievementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "streakLength": 123,
      "timeInterval": 123
    }
  ],
  "issues": [
    {
      "severity": "warning",
      "message": "Would exceed maximum freeze limit",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "user-123",
      "boostId": "550e8400-e29b-41d4-a716-446655440000",
      "index": 0
    }
  ]
}

{
  "created": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "metric",
      "points": 10,
      "status": "active",
      "userAttributes": [],
      "metricId": "660f9500-f30c-42e5-b827-557766550001",
      "metricThreshold": 5,
      "eventAttributes": [],
      "blockIfOutOfPoints": false
    }
  ],
  "issues": []
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

Tenant-ID

string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

systemId

string<uuid>

required

The UUID of the points system.

Body

application/json

Required array length: 1 - 100 elements

type

enum<string>

required

The type of trigger.

Available options:

metric,

achievement,

streak,

time,

user_creation

Example:

"metric"

points

integer

required

The number of points to award or deduct when the trigger fires. Cannot be zero.

Example:

10

status

enum<string>

default:inactive

The status of the trigger. Defaults to 'inactive'.

Available options:

active,

inactive

Example:

"inactive"

userAttributes

object[] | null

Optional user attribute filters for the trigger.

Show child attributes

metricId

string<uuid>

Required if type is metric. The UUID of the metric.

metricThreshold

integer

Required if type is metric. The metric increment that triggers the points.

Required range: x >= 1

eventAttributes

object[] | null

Optional event attribute filters. Only permitted if type is metric.

Show child attributes

achievementId

string<uuid>

Required if type is achievement. The UUID of the achievement.

streakLength

integer

Required if type is streak. The number of streak periods that triggers the points.

Required range: x >= 1

timeUnit

enum<string>

Required if type is time. The unit for the time interval.

Available options:

hours,

days

timeInterval

integer

Required if type is time. The number of time units between recurring awards.

Required range: x >= 1

blockIfOutOfPoints

boolean

default:false

Whether to block metric events that would reduce the user's points below zero. Defaults to false.

Response

Request was valid but no triggers were created (all items had issues).

Response containing created triggers and any per-item issues.

created

AdminPointsTrigger · object[]

required

Array of successfully created triggers.

Show child attributes

issues

AdminIssue · object[]

required

Array of issues encountered during trigger creation.

Show child attributes

List points triggers Delete points triggers

⌘I

Overview

Metrics

Events

Attributes

Streaks

Points

Leaderboards

Tenants

Application API Keys

Admin

Create points triggers

Authorizations

Headers

Path Parameters

Body

Response