{"info":{"title":"notification basic","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/basic/notification/channel":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/player":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/custom":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/server":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerEvent"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/generic":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/service":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerEvent"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberDetailsResponse"}}}},"400":{"description":"Bad Request"}},"security":[{"user":[]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/basic/notification/game":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Bad Request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"NotificationRequestData":{"type":"object","additionalProperties":false,"properties":{"messageParams":{"type":"array","items":{"type":"string"}},"channel":{"type":"string"},"messageKey":{"type":"string"},"context":{"type":"string"},"shard":{"type":"string"},"meta":{"type":"object","additionalProperties":{"type":"string"}},"messageFull":{"type":"string"}}},"ServerEvent":{"properties":{"event":{"type":"string"},"payload":{"type":"string"},"toAll":{"type":"boolean"}},"additionalProperties":false,"title":"Server Event","type":"object","required":["event","toAll"]},"CommonResponse":{"properties":{"result":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false,"title":"Common Response","type":"object","required":["result","data"]},"NotificationRequest":{"properties":{"payload":{"$ref":"#/components/schemas/NotificationRequestData"},"customChannelSuffix":{"type":"string"},"dbid":{"type":"integer","format":"int64"},"useSignalWhenPossible":{"type":"boolean"},"dbids":{"type":"array","items":{"type":"integer","format":"int64"}}},"additionalProperties":false,"title":"Notification Request","type":"object","required":["payload"]},"SubscriberDetailsResponse":{"properties":{"customChannelPrefix":{"type":"string"},"playerForRealmChannel":{"type":"string"},"authenticationKey":{"type":"string"},"playerChannels":{"type":"array","items":{"type":"string"}},"gameGlobalNotificationChannel":{"type":"string"},"gameNotificationChannel":{"type":"string"},"subscribeKey":{"type":"string"},"playerChannel":{"type":"string"}},"additionalProperties":false,"title":"Subscriber Details Response","type":"object","required":["subscribeKey","gameNotificationChannel","playerChannel","playerForRealmChannel","customChannelPrefix","authenticationKey","playerChannels"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}