v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Notifications

Users

Create User Notification

Sends a notification to a user.

post/cloud/v2/users/{user_id}/notifications

Path parameters

user_idstring required

The user ID.

Request body

pathstring

The resource path of the user notification.

Format: users/{user_id}/notifications/{user_notification_id}

idstring

A unique UUID of the user notification.

Example request

{
  "path": "users/123/notifications/01234567-ABCD-1234-ABCD-0123456789AB",
  "id": "a6746f2e-2cc6-11ee-be56-0242ac120002",
  "source": {
    "universe": "universes/96623001"
  },
  "payload": {
    "type": "TYPE_UNSPECIFIED",
    "messageId": "5dd7024b-68e3-ac4d-8232-4217f86ca244",
    "joinExperience": {
      "launchData": "Launch Data"
    },
    "analyticsData": {
      "category": "Bronze egg hatched"
    }
  }
}

Response

pathstring

The resource path of the user notification.

Format: users/{user_id}/notifications/{user_notification_id}

idstring

A unique UUID of the user notification.

Example response

{
  "path": "users/123/notifications/01234567-ABCD-1234-ABCD-0123456789AB",
  "id": "a6746f2e-2cc6-11ee-be56-0242ac120002",
  "source": {
    "universe": "universes/96623001"
  },
  "payload": {
    "type": "TYPE_UNSPECIFIED",
    "messageId": "5dd7024b-68e3-ac4d-8232-4217f86ca244",
    "joinExperience": {
      "launchData": "Launch Data"
    },
    "analyticsData": {
      "category": "Bronze egg hatched"
    }
  }
}