config.schema.json

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"title": "Notion Steam API integration configuration schema",
	"description": "Validates configuration input for the Notion Steam API integration.",
	"type": "object",
	"additionalProperties": false,
	"properties": {
		"$schema": {
			"description": "The JSON schema for this configuration file.",
			"type": "string",
			"default": "config.schema.json"
		},
		"notionIntegrationKey": {
			"description": "The secret integration key for your Notion integration. Find it on your integration dashboard after creating a new integration on https://www.notion.so/my-integrations",
			"type": "string",
			"default": ""
		},
		"notionDatabaseId": {
			"description": "The ID of the database you want to run the integration on. You can find the ID in the URL of your database, e.g. https://www.notion.so/myworkspace/your-database-id",
			"type": "string",
			"default": ""
		},
		"notionDataSourceId": {
			"description": "The ID of the data source you want to run the integration on. This is required if you have multiple data sources in your database. You can find the ID under the \"Manage data sources\" menu in the database settings. If you only have one data source (which is the default), you can leave this property empty.",
			"type": "string",
			"default": ""
		},
		"updateInterval": {
			"description": "The interval in which the integration will check for updates to your Notion database. The value is in milliseconds. Must be at least 60000 (1 minute).",
			"type": "integer",
			"default": 60000,
			"minimum": 60000
		},
		"steamAppIdProperty": {
			"description": "The name of the property in your Notion database that contains the Steam App ID of the games.",
			"type": "string",
			"default": "Steam App ID"
		},
		"forceReset": {
			"description": "If true, the integration will reset the local database, fetch all Steam App ID's from the Notion database and refresh all game properties. This may take longer, depending on the size of your Notion database.",
			"type": "boolean",
			"default": false
		},
		"alwaysUpdate": {
			"description": "If true, the integration will always update entries in the Notion database that were modified since it last ran, even if the game already exists in the local database. It will only update if another user than the integration has last modified the entry.",
			"type": "boolean",
			"default": false
		},
		"steamUser": {
			"description": "Login details to authenticate to your Steam account. This is required to be able to fetch tag data. If you have Steam Guard enabled, you will need to provide the Steam Guard code when running the app. Once logged in, the integration will store a local refresh token for ~200 days before you need to log in again. The integration does not transmit any of your login details anywhere, they are used internally to authenticate yourself to the Steam API. If you do not want to fetch tag data, you do not need to provide this property!",
			"type": "object",
			"default": {
				"accountName": "<steamAccountName>",
				"password": "<steamAccountPassword>"
			},
			"additionalProperties": false,
			"properties": {
				"useRefreshToken": {
					"description": "If true, the integration will try to use the refresh token stored in the local database to authenticate to your Steam account. You can only set this to \"true\" if you have previously logged in using \"accountName\" and \"password\", and the refresh token is still valid.",
					"type": "boolean",
					"default": false
				},
				"accountName": {
					"description": "Your Steam account name.",
					"type": "string",
					"default": "<steamAccountName>"
				},
				"password": {
					"description": "Your Steam account password.",
					"type": "string",
					"default": "<steamAccountPassword>"
				}
			},
			"oneOf": [
				{
					"required": [
						"accountName",
						"password"
					]
				},
				{
					"properties": {
						"useRefreshToken": {
							"const": true
						}
					},
					"required": [
						"useRefreshToken"
					]
				}
			]
		},
		"gameProperties": {
			"description": "Which game properties should be fetched when a new Steam game is detected, and the name of the corresponding field in the Notion database.",
			"type": "object",
			"default": {
				"gameName": {
					"enabled": true,
					"notionProperty": "Name",
					"isPageTitle": true
				},
				"coverImage": {
					"enabled": true,
					"default": "https://cdn.cloudflare.steamstatic.com/store/home/store_home_share.jpg"
				},
				"gameIcon": {
					"enabled": true,
					"default": "https://help.steampowered.com/public/shared/images/responsive/share_steam_logo.png"
				},
				"releaseDate": {
					"enabled": true,
					"notionProperty": "Release Date"
				},
				"reviewScore": {
					"enabled": true,
					"format": "percentage",
					"notionProperty": "Review Score"
				},
				"tags": {
					"enabled": true,
					"notionProperty": "Tags",
					"tagLanguage": "english"
				},
				"gameDescription": {
					"enabled": true,
					"notionProperty": "Description"
				},
				"storePage": {
					"enabled": true,
					"notionProperty": "Store Page"
				},
				"gamePrice": {
					"enabled": true,
					"notionProperty": "Price"
				},
				"steamDeckCompatibility": {
					"enabled": true,
					"notionProperty": "Steam Deck Compatibility"
				},
				"gameDevelopers": {
					"enabled": true,
					"notionProperty": "Developers"
				},
				"gamePublishers": {
					"enabled": true,
					"notionProperty": "Publishers"
				}
			},
			"additionalProperties": false,
			"minProperties": 1,
			"properties": {
				"gameName": {
					"description": "The name of the game as it appears on Steam. The database field in Notion must be of type \"Text\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Name",
						"isPageTitle": true
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the name of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the game name in.",
							"type": "string",
							"default": "Name"
						},
						"isPageTitle": {
							"description": "Indicates if this property is the \"Title\" of the Notion page or not.",
							"type": "boolean",
							"default": true
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"coverImage": {
					"description": "The cover image of the game as it appears on the shop page. Will be set as the cover image for the page if enabled.",
					"type": "object",
					"default": {
						"enabled": true,
						"default": "https://cdn.cloudflare.steamstatic.com/store/home/store_home_share.jpg"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the cover image of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"default": {
							"description": "The URL of the image to use if the game does not have a cover image through any of the two API's.",
							"type": "string",
							"default": "https://cdn.cloudflare.steamstatic.com/store/home/store_home_share.jpg",
							"format": "uri",
							"pattern": "^https?://"
						}
					},
					"required": [
						"enabled"
					]
				},
				"gameIcon": {
					"description": "The icon of the game as it appears in the game library. Will be set as the icon for the page if enabled.",
					"type": "object",
					"default": {
						"enabled": true,
						"default": "https://help.steampowered.com/public/shared/images/responsive/share_steam_logo.png"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the icon of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"default": {
							"description": "The URL of the image to use if the game does not have an icon through any of the two API's.",
							"type": "string",
							"default": "https://help.steampowered.com/public/shared/images/responsive/share_steam_logo.png",
							"format": "uri",
							"pattern": "^https?://"
						}
					},
					"required": [
						"enabled"
					]
				},
				"releaseDate": {
					"description": "The release date of the game. The database field in Notion must be of type \"Date\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Release Date"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the release date of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the release date in.",
							"type": "string",
							"default": "Release Date"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"reviewScore": {
					"description": "The user review score for the game, formatted as one of a number of options. The database field in Notion must match the type defined by the chosen \"format\".",
					"type": "object",
					"default": {
						"enabled": true,
						"format": "percentage",
						"notionProperty": "Review Score"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the user review score should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"format": {
							"description": "How the review score should be formatted.",
							"type": "string",
							"default": "percentage",
							"oneOf": [
								{
									"const": "percentage",
									"title": "Notion database field type: \"Number\". A percentage value formatted as a float from 0.00-1.00."
								},
								{
									"const": "sentiment",
									"title": "Notion database field type: \"Select\". A sentiment value such as \"Overwhelmingly Positive\" or \"Mixed\"."
								},
								{
									"const": "total",
									"title": "Notion database field type: \"Number\". The total number of reviews submitted for the game, across all languages."
								},
								{
									"const": "positive",
									"title": "Notion database field type: \"Number\". The total number of positive reviews submitted for the game, across all languages."
								},
								{
									"const": "negative",
									"title": "Notion database field type: \"Number\". The total number of negative reviews submitted for the game, across all languages."
								},
								{
									"const": "positive/negative",
									"title": "Notion database field type: \"Text\". The total number of positive and negative reviews submitted for the game, across all languages, formatted as \"{numPositive} positive / {numNegative} negative\"."
								}
							]
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the user review score in.",
							"type": "string",
							"default": "Review Score"
						}
					},
					"required": [
						"enabled",
						"format",
						"notionProperty"
					]
				},
				"tags": {
					"description": "Requires Steam login! Provide \"accountName\" and \"password\" in the top-level \"steamUser\" property, \"refreshToken\" if you already logged in before! The user-defined tags of the game as they can be seen on the store page. The database field in Notion must be of type \"Multi-select\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Tags",
						"tagLanguage": "english"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the tags of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the tags in. This field must be of type \"multi-select\".",
							"type": "string",
							"default": "Tags"
						},
						"tagLanguage": {
							"description": "The language of the tags, e.g. \"english\" or \"spanish\".",
							"type": "string",
							"default": "english"
						}
					},
					"required": [
						"enabled",
						"notionProperty",
						"tagLanguage"
					]
				},
				"gameDescription": {
					"description": "The short description of the game as it appears on the store page. The database field in Notion must be of type \"Text\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Description"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the description of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the description in.",
							"type": "string",
							"default": "Description"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"storePage": {
					"description": "The URL to the store page of the game. The database field in Notion must be of type \"URL\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Store Page"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the store page URL should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the store page URL in.",
							"type": "string",
							"default": "Store Page"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"gamePrice": {
					"description": "The price of the game on Steam. Does not account for current sales or discounts (as this data would be outdated too quickly). The currency depends on your current country. The database field in Notion must be of type \"Number\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Price"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the price of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the price in.",
							"type": "string",
							"default": "Price"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"steamDeckCompatibility": {
					"description": "The Steam Deck Compatibility score, which can be one of \"Verified\", \"Playable\", \"Unsupported\" or \"Unknown\". The database field in Notion must be of type \"Select\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Steam Deck Compatibility"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the Steam Deck compatibility should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the Steam Deck compatibility in.",
							"type": "string",
							"default": "Steam Deck Compatibility"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"gameDevelopers": {
					"description": "The developer(s) of the game. The database field in Notion must be of type \"Multi-select\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Developers"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the developer(s) of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the developer(s) in.",
							"type": "string",
							"default": "Developers"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				},
				"gamePublishers": {
					"description": "The publisher(s) of the game. The database field in Notion must be of type \"Multi-select\".",
					"type": "object",
					"default": {
						"enabled": true,
						"notionProperty": "Publishers"
					},
					"additionalProperties": false,
					"properties": {
						"enabled": {
							"description": "Whether or not the publisher(s) of the game should be set in the database.",
							"type": "boolean",
							"default": true
						},
						"notionProperty": {
							"description": "The name of the Notion property to set the publisher(s) in.",
							"type": "string",
							"default": "Publishers"
						}
					},
					"required": [
						"enabled",
						"notionProperty"
					]
				}
			}
		}
	},
	"required": [
		"notionIntegrationKey",
		"notionDatabaseId",
		"updateInterval",
		"steamAppIdProperty",
		"gameProperties"
	],
	"allOf": [
		{
			"if": {
				"properties": {
					"gameProperties": {
						"properties": {
							"tags": {
								"properties": {
									"enabled": {
										"const": true
									}
								}
							}
						}
					}
				}
			},
			"then": {
				"required": [
					"steamUser"
				]
			}
		}
	]
}