User info

The user info channel delivers updates about the user.

[TOC]

UserInfo JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://bet_stack.com/user_info_channel_schema",
  "title": "UserInfo",
  "type": "object",
  "description": "Information about the user",
  "properties": {
    "address1": {
      "description": "The address line 1 of the user's address.",
      "type": "string",
      "format": "alphanumeric"
    },
    "address2": {
      "description": "The optional address line 2 of the user's address.",
      "type": "string",
      "format": "alphanumeric"
    },
    "city": {
      "description": "The city of the user's address.",
      "type": "string",
      "format": "alpha"
    },
    "country": {
      "description": "The country of the user's address.",
      "type": "string",
      "format": "alpha"
    },
    "dateOfBirth": {
      "description": "The date of birth of the user.",
      "type": "string",
      "format": "yyyy-mm-dd"
    },
    "firstName": {
      "description": "The first name of the user.",
      "type": "string",
      "format": "alpha"
    },
    "industry": {
      "description": "The industry in which the user is employed.",
      "type": "string",
      "format": "alpha"
    },
    "jobTitle": {
      "description": "The job title of the user.",
      "type": "string",
      "format": "alphanumeric"
    },
    "lastName": {
      "description": "The last name of the user.",
      "type": "string",
      "format": "alpha"
    },
    "optInMarketing": {
      "description": "If the user has opted-in for marketing information from STX",
      "type": "boolean",
      "format": "true or false"
    },
    "passwordChanged": {
      "description": "If the user has changed the password or not. It will send true as soon as the user changed the password",
      "type": "boolean",
      "format": "true or false"
    },
    "phoneNumber": {
      "description": "The phone number of the user.",
      "type": "string",
      "format": "number"
    },
    "pictureUrl": {
      "description": "The url of the uploaded picture of the user.",
      "type": "string",
      "format": "alphanumeric"
    },
    "state": {
      "description": "The state in the address of the user.",
      "type": "string",
      "format": "alpha"
    },
    "testAccount": {
      "description": "If this user's account is marked as test account.",
      "type": "boolean",
      "format": "true or false"
    },
    "userId": {
      "description": "The ID of the user",
      "type": "string",
      "format": "uuid"
    },
    "userUid": {
      "description": "The external user id of the user.",
      "type": "string",
      "format": "alphanumeric"
    },
    "userStatus": {
      "description": "The status of the user.",
      "type": "string",
      "enum": [
        "archived",
        "pending_approval",
        "active",
        "suspended",
        "banned",
        "self_excluded",
        "closed",
        "rejected",
        "dormant"
      ]
    },
    "username": {
      "description": "The generated username of the user.",
      "type": "string",
      "format": "alpha"
    },
    "zipCode": {
      "description": "The zip code in the address of the user.",
      "type": "string",
      "format": "number"
    }
  }
}

Joining

["3","3","user_info:{{userUid}}","phx_join", ""]

Example responses:

[
  "1",
  "1",
  "user_info:v5yDoWte75hCuhp3ejRMPTWz8Yz1",
  "phx_reply",
  {
    "response": {},
    "status": "ok"
  }
]

Live updates

User Info changes

When an user’s information changes an update is pushed to the channel.

[[
  null,
  null,
  "user_info:v5yDoWte75hCuhp3ejRMPTWz8Yz1",
  "user_updated",
  {
    "address1": "123 Main St",
    "address2": null,
    "city": "New York",
    "country": "USA",
    "dateOfBirth": "1988-03-05",
    "firstName": "Jonny",
    "industry": null,
    "jobTitle": null,
    "lastName": "Lu",
    "optInMarketing": true,
    "password_changed": false,
    "phoneNumber": null,
    "pictureUrl": null,
    "state": "NY",
    "test_account": false,
    "userId": "7fb55544-3a7e-4f6b-bd66-fc89bd3a1087",
    "userStatus": "active",
    "userUid": "v5yDoWte75hCuhp3ejRMPTWz8Yz1",
    "username": "Lu.Jonny.47541",
    "zipCode": "10121"
  }
]