post https://{publisher-server}/
POST HTTP request to the game server with an URL configured in the dashboard.
Note: You can read more about how Appcharge handles Player Authentication, and the Player Authentication Webhook, in the Guides section.
Response fields reference:
200 login Succeeded
- status - The request was valid/invalid.
- playerProfileImage - The profile image of the player. If no image is available, an empty string must be provided. A default image will be displayed in this case.
- publisherPlayerId - The player id.
- playerName - The player name (optional).
- sessionMetadata - Deprecated. This entity serves as a versatile container for storing any pertinent information related to the player's session. It will be sent back in the Player Orders Reporting web-hook, and Player Data Sync (if it's enabled). Can be of data type Object (Key-Value).
400 Failed to Authenticate
- status - The request was valid/invalid.
- publisherErrorMessage - A descriptive error message returned to the publisher, explaining why authentication failed. This message is displayed to players on the login failed screen.
- publisherErrorMessageType - An optional field that specifies the type of error message. Possible values:
none– no error message is providedplainText– a basic error message in plain textenrichedText– a formatted error message in MD format that may contain additional styling or elements
Note: It’s important to ensure that the schema on the receiving end is flexible rather than rigid. This will allow the publisher to receive any extra properties we may introduce in the future without causing issues or requiring changes on their end.