Post Function Result For Player Triggered Action
Generate a player PlayStream event for the provided function result.
Allowed entity token types: title
POST
/
CloudScript
/
PostFunctionResultForPlayerTriggeredAction
Post Function Result For Player Triggered Action
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"PlayStreamEventEnvelope": {
"EntityId": "1234ABCD",
"EntityType": "title_player_account",
"EventName": "player_logged_in",
"EventNamespace": "com.playfab",
"EventData": "someeventdata",
"EventSettings": "someeventsettings"
},
"PlayerProfile": {
"TitleId": "FFFF",
"PlayerId": "1234ABCD",
"Created": "2019-02-11T20:23:05",
"LastLogin": "2020-02-11T20:23:05",
"DisplayName": "Gudge"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": {
"newScore": 25
},
"FunctionResultSize": 43
}
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction"
payload = {
"PlayStreamEventEnvelope": {
"EntityId": "1234ABCD",
"EntityType": "title_player_account",
"EventName": "player_logged_in",
"EventNamespace": "com.playfab",
"EventData": "someeventdata",
"EventSettings": "someeventsettings"
},
"PlayerProfile": {
"TitleId": "FFFF",
"PlayerId": "1234ABCD",
"Created": "2019-02-11T20:23:05",
"LastLogin": "2020-02-11T20:23:05",
"DisplayName": "Gudge"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": { "newScore": 25 },
"FunctionResultSize": 43
}
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
PlayStreamEventEnvelope: {
EntityId: '1234ABCD',
EntityType: 'title_player_account',
EventName: 'player_logged_in',
EventNamespace: 'com.playfab',
EventData: 'someeventdata',
EventSettings: 'someeventsettings'
},
PlayerProfile: {
TitleId: 'FFFF',
PlayerId: '1234ABCD',
Created: '2019-02-11T20:23:05',
LastLogin: '2020-02-11T20:23:05',
DisplayName: 'Gudge'
},
FunctionResult: {
ExecutionTimeMilliseconds: 367,
FunctionName: 'LevelCompleted',
FunctionResult: {newScore: 25},
FunctionResultSize: 43
}
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction', 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://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction",
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([
'PlayStreamEventEnvelope' => [
'EntityId' => '1234ABCD',
'EntityType' => 'title_player_account',
'EventName' => 'player_logged_in',
'EventNamespace' => 'com.playfab',
'EventData' => 'someeventdata',
'EventSettings' => 'someeventsettings'
],
'PlayerProfile' => [
'TitleId' => 'FFFF',
'PlayerId' => '1234ABCD',
'Created' => '2019-02-11T20:23:05',
'LastLogin' => '2020-02-11T20:23:05',
'DisplayName' => 'Gudge'
],
'FunctionResult' => [
'ExecutionTimeMilliseconds' => 367,
'FunctionName' => 'LevelCompleted',
'FunctionResult' => [
'newScore' => 25
],
'FunctionResultSize' => 43
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction"
payload := strings.NewReader("{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
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://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
application/json
The result of the function execution.
Show child attributes
Show child attributes
Example:
{
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": { "newScore": 25 },
"FunctionResultSize": 43
}
The player profile the function was invoked with.
Show child attributes
Show child attributes
Example:
{
"TitleId": "FFFF",
"PlayerId": "1234ABCD",
"Created": "2019-02-11T20:23:05",
"LastLogin": "2020-02-11T20:23:05",
"DisplayName": "Gudge"
}
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The triggering PlayStream event, if any, that caused the function to be invoked.
Show child attributes
Show child attributes
Last modified on October 1, 2026
Was this page helpful?
⌘I
Post Function Result For Player Triggered Action
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"PlayStreamEventEnvelope": {
"EntityId": "1234ABCD",
"EntityType": "title_player_account",
"EventName": "player_logged_in",
"EventNamespace": "com.playfab",
"EventData": "someeventdata",
"EventSettings": "someeventsettings"
},
"PlayerProfile": {
"TitleId": "FFFF",
"PlayerId": "1234ABCD",
"Created": "2019-02-11T20:23:05",
"LastLogin": "2020-02-11T20:23:05",
"DisplayName": "Gudge"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": {
"newScore": 25
},
"FunctionResultSize": 43
}
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction"
payload = {
"PlayStreamEventEnvelope": {
"EntityId": "1234ABCD",
"EntityType": "title_player_account",
"EventName": "player_logged_in",
"EventNamespace": "com.playfab",
"EventData": "someeventdata",
"EventSettings": "someeventsettings"
},
"PlayerProfile": {
"TitleId": "FFFF",
"PlayerId": "1234ABCD",
"Created": "2019-02-11T20:23:05",
"LastLogin": "2020-02-11T20:23:05",
"DisplayName": "Gudge"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": { "newScore": 25 },
"FunctionResultSize": 43
}
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
PlayStreamEventEnvelope: {
EntityId: '1234ABCD',
EntityType: 'title_player_account',
EventName: 'player_logged_in',
EventNamespace: 'com.playfab',
EventData: 'someeventdata',
EventSettings: 'someeventsettings'
},
PlayerProfile: {
TitleId: 'FFFF',
PlayerId: '1234ABCD',
Created: '2019-02-11T20:23:05',
LastLogin: '2020-02-11T20:23:05',
DisplayName: 'Gudge'
},
FunctionResult: {
ExecutionTimeMilliseconds: 367,
FunctionName: 'LevelCompleted',
FunctionResult: {newScore: 25},
FunctionResultSize: 43
}
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction', 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://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction",
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([
'PlayStreamEventEnvelope' => [
'EntityId' => '1234ABCD',
'EntityType' => 'title_player_account',
'EventName' => 'player_logged_in',
'EventNamespace' => 'com.playfab',
'EventData' => 'someeventdata',
'EventSettings' => 'someeventsettings'
],
'PlayerProfile' => [
'TitleId' => 'FFFF',
'PlayerId' => '1234ABCD',
'Created' => '2019-02-11T20:23:05',
'LastLogin' => '2020-02-11T20:23:05',
'DisplayName' => 'Gudge'
],
'FunctionResult' => [
'ExecutionTimeMilliseconds' => 367,
'FunctionName' => 'LevelCompleted',
'FunctionResult' => [
'newScore' => 25
],
'FunctionResultSize' => 43
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction"
payload := strings.NewReader("{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
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://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\"\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05\",\n \"LastLogin\": \"2020-02-11T20:23:05\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25\n },\n \"FunctionResultSize\": 43\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}