Message

message

send/receive with other obniz Board or WebHook

request: send

Related item

path type conditions description
message.data anyType
  • required
All type of data is pass. 
message.to[] obnizId
  • required
 
// Json Example
[
    {
        "message": {
            "data": "button pressed",
            "to": [
                "1234-5678"
            ]
        }
    }
]

response: receive

Related item

path type conditions description
message.data anyType
  • required
All type of data is pass. 
message.from string,null   From obniz id. Null is used when WebHook message. 
//Response Example
[
    {
        "message": {
            "data": "button pressed",
            "from": "1234-5678"
        }
    }
]

type defines

obnizId

type conditions examples description
string,integer
  • 0 ≤ value ≤ 99999999
  • "1234-5678"
  • 12345678
Obniz id. It can contain '-' or not.