Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
d0a914d
Update MPS Playstream event references with changes from playfab-docs…
valexao Jan 6, 2026
749f39a
Updates for OSS V1 UE5.6 release (#2765)
rgomez391 Jan 6, 2026
cae84f3
Update CODEOWNERS for playfab-docs directory to add Xbox Learning Res…
edigonzales-microsoft Jan 12, 2026
1b7e08e
Xbox Title Add-on Update to enabled PC title linking (#2749)
antnguyen89 Jan 12, 2026
49db015
Increase Acrolinx quality score from 70 to 80 (#2763)
edigonzales-microsoft Jan 12, 2026
d0d3d89
Update release-notes.md, PlayFab Party Release Notes [1.10.13][1.10.1…
SebastianPD Jan 12, 2026
1dae051
Update master_player_account description in Available built-in entity…
cindyjohnson-msft Jan 13, 2026
ebc1d90
Bug 60687305: PFGameSaves SteamDeck: improve docs based on customer q…
jasonsandlin Jan 13, 2026
ad2f2f0
Merge main into live branch (#2770)
valexao Jan 13, 2026
c2dbf27
Adding missing elements to the links on the menu (#2747)
braulioal Jan 14, 2026
499d2f6
PF English edits 59226148 (#2745)
rickcarr044 Jan 14, 2026
4e52ef7
PF English edits 59213568 (#2744)
rickcarr044 Jan 14, 2026
f4ac96d
Update loginidentityprovider.md (#2730)
ychikazawa Jan 14, 2026
8d9b0cd
fix typo in event name (#2725)
hekemp Jan 14, 2026
05f8428
Resolve syncing conflicts from repo_sync_working_branch to main (#2774)
learn-build-service-prod[bot] Jan 14, 2026
54954d4
PF trademark edits-60743178 (#2772)
rickcarr044 Jan 14, 2026
eee4c9d
Merge Main > Live (Jan 2026) (#2775)
edigonzales-microsoft Jan 14, 2026
c08c72a
Update webhook calls documentation with IP allowlisting info (#2777)
cindyjohnson-msft Jan 21, 2026
2185aea
Add a common properties docfx template for Playstream Events Common P…
valexao Jan 22, 2026
1598d1d
Add game save telemetry/playstream event documentation (#2780)
alzakrze Jan 22, 2026
6b17e51
PFMultiplayer: Refresh errors doc page + include pubsub errors (#2781)
ScottMunroMS Jan 26, 2026
bff531e
PlayFabParty: Refresh errors doc page from auto-generated source (#2782)
ScottMunroMS Jan 26, 2026
c85b06d
Sony trademark edits 60869667 (#2783)
rickcarr044 Jan 27, 2026
8bfc72c
Kkline lobby (#2786)
keithrkline Jan 28, 2026
7b2ef7c
ADO 59008382: Clarify Azure Blob SAS permissions (#2785)
foxvalo Jan 29, 2026
6d19806
60428657_clarification_language (#2787)
foxvalo Jan 29, 2026
cada583
60428583 Unreal update (#2788)
foxvalo Jan 29, 2026
7099e58
Updates for OSS V1 UE5.7 release (#2795)
rgomez391 Feb 5, 2026
c6ef4b4
Add Party 1.10.16 release notes. (#2789)
tomcoMSFT Feb 6, 2026
8b96149
Add scheduled workflow to merge Main into Live on 2nd and 4th Tuesday…
Copilot Feb 6, 2026
271262a
[WIP] Update merge-main-to-live workflow for code owner approval (#2798)
Copilot Feb 6, 2026
e180c2a
60428644_playfab_support_language_update (#2794)
foxvalo Feb 6, 2026
e09847e
Align merge-main-to-live workflow with gdk-docs-pr pattern (#2799)
Copilot Feb 6, 2026
2b8149f
PlayStream documentation update AdPlacement, Addons, ApiAccessPolicy,…
ronnyparedesc Feb 9, 2026
5ac4eac
Revise API rate limits for inventory and redemption (#2802)
ernesto1596 Feb 10, 2026
7204c33
PlayStream event documentation update Extensions, Functions, Groups, …
ronnyparedesc Feb 10, 2026
01aa003
Merge branch 'main' into live
edigonzales-microsoft Feb 10, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .acrolinx-config.edn
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
}
:scores {
;;:terminology 100
:qualityscore 70
:qualityscore 80
;;:spelling 40
}
}
Expand Down
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

# The '*' pattern is global owners.

/playfab-docs/ @KevinAsgari @williacj @thomasgu
/playfab-docs/ @MicrosoftDocs/xbox-learning-resources @williacj @thomasgu
166 changes: 166 additions & 0 deletions .github/workflows/merge-main-to-live.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
name: Merge Main to Live

on:
schedule:
# Run at 9:00 AM UTC every Tuesday
- cron: '0 9 * * 2'
workflow_dispatch: # Allow manual trigger for testing

jobs:
merge:
runs-on: ubuntu-latest
permissions:
contents: read # Required for checking out code
pull-requests: write # Required for creating pull requests
issues: write # Required for creating issues on failure

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}

- name: Check if today is 2nd or 4th Tuesday
id: check_date
run: |
# Get current day of month
DAY=$(date +%d)
# Get day of week (1=Monday, 2=Tuesday, ..., 7=Sunday)
DOW=$(date +%u)

# Check if today is Tuesday (2)
if [ "$DOW" -eq 2 ]; then
# Calculate which week of the month we're in (1-5)
# Remove leading zero if present
DAY=$((10#$DAY))
WEEK=$(( (DAY - 1) / 7 + 1 ))

# Check if it's the 2nd or 4th Tuesday
if [ "$WEEK" -eq 2 ] || [ "$WEEK" -eq 4 ]; then
echo "is_target_tuesday=true" >> $GITHUB_OUTPUT
echo "This is the 2nd or 4th Tuesday of the month"
else
echo "is_target_tuesday=false" >> $GITHUB_OUTPUT
echo "This is not the 2nd or 4th Tuesday"
fi
else
echo "is_target_tuesday=false" >> $GITHUB_OUTPUT
echo "Today is not Tuesday"
fi

- name: Check for existing PR
if: steps.check_date.outputs.is_target_tuesday == 'true'
id: check_pr
uses: actions/github-script@v7
with:
script: |
const { data: pulls } = await github.rest.pulls.list({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'open',
head: `${context.repo.owner}:Main`,
base: 'Live'
});

if (pulls.length > 0) {
core.setOutput('pr_exists', 'true');
core.setOutput('pr_number', pulls[0].number);
core.setOutput('pr_url', pulls[0].html_url);
} else {
core.setOutput('pr_exists', 'false');
}

- name: Create Pull Request
if: steps.check_date.outputs.is_target_tuesday == 'true' && steps.check_pr.outputs.pr_exists == 'false'
id: create_pr
uses: actions/github-script@v7
with:
script: |
const date = new Date().toISOString().split('T')[0];
const title = `Scheduled Merge: Main to Live on ${date}`;
const body = [
'This is an automated pull request to merge Main into Live branch.',
'',
`**Scheduled merge date:** ${date}`,
`**Schedule:** This PR is created on the 2nd and 4th Tuesday of each month.`,
`**Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`,
'',
'**Instructions:**',
'- Review the changes',
'- Ensure all checks pass',
'- Code owners should approve this PR',
'- Merge when ready',
'',
'If there are conflicts, they will need to be resolved manually.',
'',
'---',
'*This PR was automatically created by the scheduled merge workflow.*'
].join('\n');

try {
const { data: pr } = await github.rest.pulls.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: title,
body: body,
head: 'Main',
base: 'Live'
});

core.setOutput('pr_number', pr.number);
core.setOutput('pr_url', pr.html_url);
console.log(`Pull request created: ${pr.html_url}`);
} catch (error) {
core.setFailed(`Failed to create pull request: ${error.message}`);
throw error;
}

- name: Comment on existing PR
if: steps.check_date.outputs.is_target_tuesday == 'true' && steps.check_pr.outputs.pr_exists == 'true'
uses: actions/github-script@v7
env:
PR_NUMBER: ${{ steps.check_pr.outputs.pr_number }}
with:
script: |
const date = new Date().toISOString().split('T')[0];
const prNumber = parseInt(process.env.PR_NUMBER);
const comment = [
`♻️ Scheduled merge workflow ran again on ${date}.`,
'',
'This PR is still open and ready for review.',
'',
`**Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`
].join('\n');

await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: prNumber,
body: comment
});

console.log(`Comment added to existing PR #${prNumber}`);

- name: Create Issue on Failure
if: failure() && steps.check_date.outputs.is_target_tuesday == 'true'
uses: actions/github-script@v7
with:
script: |
const date = new Date().toISOString().split('T')[0];
const title = `Scheduled Merge PR Creation Failed: Main to Live on ${date}`;
const body = [
'The scheduled merge workflow failed to create a pull request from Main to Live branch.',
'',
`**Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}`,
'',
'Please review the workflow logs and create the pull request manually if needed.'
].join('\n');

await github.rest.issues.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: title,
body: body,
labels: ['workflow-failure', 'automated']
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: title_addon_changed
author: ronnyparedes
description: title_addon_changed event.
ms.author: ronnyparedes
ms.date: 06/02/2026
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# title_addon_changed

This event is triggered when a marketplace AddOn is installed, or changes state.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|AddOnId|String|Unique identifier of the AddOn affected.|
|AddOnName|String|Name of the AddOn affected.|
|DeveloperId|String|Developer/Studio ID.|
|State|[AddOnProvisioningState](../data-types/addonprovisioningstate.md)|Current state of the AddOn. Values include Inactive, Paused, Active, Pending, and PendingWithError.|
|UserId|String|May be null if user is unknown (Admin API, partner source).|

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: title_api_settings_changed
author: joannaleecy
description: title_api_settings_changed event.
ms.author: jenelleb
ms.date: 02/19/2019
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# title_api_settings_changed

This event is triggered when an API Features setting is changed for the title.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|DeveloperId|String||
|PreviousSettingsValues|[APISettings](../data-types/apisettings.md)|Settings values before the change.|
|SettingsValues|[APISettings](../data-types/apisettings.md)|Settings values after the change.|
|UserId|String||

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: title_permission_policy_changed
author: joannaleecy
description: title_permission_policy_changed event.
ms.author: jenelleb
ms.date: 02/19/2019
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# title_permission_policy_changed

This event is triggered when an update occurs to a a title's permission policies.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|DeveloperId|String||
|NewPolicy|String|The contents new policy.|
|PolicyName|String|The name of the policy that was changed|
|UserId|String||

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: cloudscript_executed
author: ronnyparedes
description: cloudscript_executed event.
ms.author: ronnyparedes
ms.date: 06/02/2026
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# cloudscript_executed

This event is triggered when a CloudScript function is executed.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|The details of the execution result.|
|FunctionName|String|Name of the CloudScript function that was executed.|
|Source|String|The source that caused the function to be executed; PlayStreamV2, Task.|

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv2.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: entity_executed_cloud_script
author: joannaleecy
description: entity_executed_cloud_script event.
ms.author: jenelleb
ms.date: 02/19/2019
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# entity_executed_cloud_script

This event is optionally triggered when a CloudScript function is executed by calling the ExecuteEntityCloudScript API. If you want the Event logged, you can pass in GeneratePlayStreamEvent.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.|
|EntityChain|String|The chain of ownership for this entity.|
|EntityLineage|[EntityLineage](../data-types/entitylineage.md)|Entities that this entity is a child of.|
|FunctionName|String|Name of the CloudScript function that was called.|

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: player_executed_cloudscript
author: joannaleecy
description: player_executed_cloudscript event.
ms.author: jenelleb
ms.date: 02/19/2019
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# player_executed_cloudscript

This event is optionally triggered when a CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including diagnostic information that is useful for debugging.|
|FunctionName|String|Name of the CloudScript function that was called.|
|TitleId|String|The ID of the title to which this player event applies.|

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: player_triggered_action_executed_cloudscript
author: joannaleecy
description: player_triggered_action_executed_cloudscript event.
ms.author: jenelleb
ms.date: 02/19/2019
ms.topic: article
ms.service: azure-playfab
keywords: playfab, playstream events
ms.localizationpriority: medium
---

# player_triggered_action_executed_cloudscript

This event is triggered when a CloudScript function is run as the result of a PlayStream action, and the 'Publish results as a PlayStream Event' box was checked.

## Properties

|Name|Type|Description|
| :--------------------|:-------------------|:----------------------|
|CloudScriptExecutionResult|[ExecuteCloudScriptResult](../data-types/executecloudscriptresult.md)|Result of the CloudScript function, including an error information. Useful for debugging.|
|FunctionName|String|Name of the CloudScript function that was called.|
|TitleId|String|The ID of the title to which this player event applies.|
|TriggeringEventData|object|The full JSON data of the event that triggered this CloudScript function to run. Useful for debugging.|
|TriggeringEventName|String|Name of the event that triggered this CloudScript function to run.|
|TriggeringPlayer|[PlayerProfile](../data-types/playerprofile.md)|JSON data profile of the player that triggered this CloudScript function to run.|

## Common Properties

[!INCLUDE [common-properties](../../../includes/_common-properties-eventsv1.md)]
Loading