Post Function Result For Scheduled Task
Generate a PlayStream event for the provided function result.
Allowed entity token types: title
POST
/
CloudScript
/
PostFunctionResultForScheduledTask
Post Function Result For Scheduled Task
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"ScheduledTaskId": {
"Name": "MyTask",
"Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": {
"newScore": 25
},
"FunctionResultSize": 43
}
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask"
payload = {
"ScheduledTaskId": {
"Name": "MyTask",
"Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
},
"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({
ScheduledTaskId: {Name: 'MyTask', Id: 'd739e188-22f6-4d13-a4d5-df2e93d4d2f7'},
FunctionResult: {
ExecutionTimeMilliseconds: 367,
FunctionName: 'LevelCompleted',
FunctionResult: {newScore: 25},
FunctionResultSize: 43
}
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask', 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/PostFunctionResultForScheduledTask",
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([
'ScheduledTaskId' => [
'Name' => 'MyTask',
'Id' => 'd739e188-22f6-4d13-a4d5-df2e93d4d2f7'
],
'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/PostFunctionResultForScheduledTask"
payload := strings.NewReader("{\n \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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/PostFunctionResultForScheduledTask")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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/PostFunctionResultForScheduledTask")
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 \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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 id of the scheduled task that invoked the function.
Show child attributes
Show child attributes
Example:
{ "Name": "MyTask", "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7" }
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Last modified on October 1, 2026
Was this page helpful?
⌘I
Post Function Result For Scheduled Task
curl --request POST \
--url https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"ScheduledTaskId": {
"Name": "MyTask",
"Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
},
"FunctionResult": {
"ExecutionTimeMilliseconds": 367,
"FunctionName": "LevelCompleted",
"FunctionResult": {
"newScore": 25
},
"FunctionResultSize": 43
}
}
'import requests
url = "https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask"
payload = {
"ScheduledTaskId": {
"Name": "MyTask",
"Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
},
"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({
ScheduledTaskId: {Name: 'MyTask', Id: 'd739e188-22f6-4d13-a4d5-df2e93d4d2f7'},
FunctionResult: {
ExecutionTimeMilliseconds: 367,
FunctionName: 'LevelCompleted',
FunctionResult: {newScore: 25},
FunctionResultSize: 43
}
})
};
fetch('https://{titleId}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask', 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/PostFunctionResultForScheduledTask",
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([
'ScheduledTaskId' => [
'Name' => 'MyTask',
'Id' => 'd739e188-22f6-4d13-a4d5-df2e93d4d2f7'
],
'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/PostFunctionResultForScheduledTask"
payload := strings.NewReader("{\n \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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/PostFunctionResultForScheduledTask")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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/PostFunctionResultForScheduledTask")
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 \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\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": {}
}