Get a reward event trigger

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "negated": true,
  "parent_trigger_group_name": "<string>",
  "trigger_description": "<string>",
  "trigger_id": "<string>",
  "trigger_name": "<string>",
  "trigger_type": "REWARD_EVENT",
  "event_names": [
    "<string>"
  ],
  "reward_states": [],
  "slots": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}

GET

campaigns

{campaignId}

{version}

controllers

{controllerId}

triggers

reward-events

{triggerId}

Get a reward event trigger

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/triggers/reward-events/{triggerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "negated": true,
  "parent_trigger_group_name": "<string>",
  "trigger_description": "<string>",
  "trigger_id": "<string>",
  "trigger_name": "<string>",
  "trigger_type": "REWARD_EVENT",
  "event_names": [
    "<string>"
  ],
  "reward_states": [],
  "slots": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

controllerId

string

required

triggerId

string

required

Response

Successful response

component_ids

string[]

component_references

object[]

Show child attributes

enabled

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.

negated

The negated as configured: a literal value, or an expression (type:string) when defined dynamically.

parent_trigger_group_name

The parent trigger group name as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_description

The trigger description as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_id

string

trigger_name

The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.

trigger_phase

The trigger phase as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

MATCHING,

QUALIFYING,

QUALITY

trigger_type

enum<string>

Available options:

REWARD_EVENT

event_names

The event names as configured: a literal value, or an expression (type:string) when defined dynamically.

reward_states

The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

CANCELED,

EARNED,

FAILED,

FULFILLED,

REDEEMED,

REVOKED

slots

The slots as configured: a literal value, or an expression (type:string) when defined dynamically.

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Get a reward event trigger

Authorizations

Path Parameters

Response