Track when a user redeems their points
curl --request POST \
--url https://api.pocketflows.com/track \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "<string>",
"user_id": "<string>",
"location_id": "<string>",
"rewards_program_id": "<string>",
"location_member_id": "<string>",
"member_id": "<string>",
"points": 123
}
'import requests
url = "https://api.pocketflows.com/track"
payload = {
"event": "<string>",
"user_id": "<string>",
"location_id": "<string>",
"rewards_program_id": "<string>",
"location_member_id": "<string>",
"member_id": "<string>",
"points": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: '<string>',
user_id: '<string>',
location_id: '<string>',
rewards_program_id: '<string>',
location_member_id: '<string>',
member_id: '<string>',
points: 123
})
};
fetch('https://api.pocketflows.com/track', 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.pocketflows.com/track",
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([
'event' => '<string>',
'user_id' => '<string>',
'location_id' => '<string>',
'rewards_program_id' => '<string>',
'location_member_id' => '<string>',
'member_id' => '<string>',
'points' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/track"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pocketflows.com/track")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/track")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"event_name": "<string>",
"member": "<string>"
}Track when a user redeems their points
POST
/
track
Track when a user redeems their points
curl --request POST \
--url https://api.pocketflows.com/track \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "<string>",
"user_id": "<string>",
"location_id": "<string>",
"rewards_program_id": "<string>",
"location_member_id": "<string>",
"member_id": "<string>",
"points": 123
}
'import requests
url = "https://api.pocketflows.com/track"
payload = {
"event": "<string>",
"user_id": "<string>",
"location_id": "<string>",
"rewards_program_id": "<string>",
"location_member_id": "<string>",
"member_id": "<string>",
"points": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event: '<string>',
user_id: '<string>',
location_id: '<string>',
rewards_program_id: '<string>',
location_member_id: '<string>',
member_id: '<string>',
points: 123
})
};
fetch('https://api.pocketflows.com/track', 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.pocketflows.com/track",
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([
'event' => '<string>',
'user_id' => '<string>',
'location_id' => '<string>',
'rewards_program_id' => '<string>',
'location_member_id' => '<string>',
'member_id' => '<string>',
'points' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pocketflows.com/track"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pocketflows.com/track")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/track")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"rewards_program_id\": \"<string>\",\n \"location_member_id\": \"<string>\",\n \"member_id\": \"<string>\",\n \"points\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"event_name": "<string>",
"member": "<string>"
}Parameters
string
default:"user.redeem"
required
Must be
user.redeemstring
The ID of the user. Must be provided in conjunction with either
location_id
or rewards_program_idstring
The ID of the location where the redemption was made. Must be provided in
conjunction with
user_idstring
The ID of the rewards program that the user is redeeming under. Useful when
redemptions are made at the brand level rather than in-store. Should not be
simultaneously provided with
location_idstring
The ID of the location member. Can be used instead of a providing a pair of
user_id and location_idstring
The ID of the rewards program member. Can be used instead of providing a pair
of
user_id and rewards_program_id.integer
required
The number of points to redeem
Returns
string
The ID of the event
string
The name of the event that was captured
string
Show child attributes
Show child attributes