Can I send a message using the OnSong Connect API?

Can I send a message using the OnSong Connect API?

The OnSong Connect API allows you to send information to devices running OnSong.  If you're a developer who wants to integrate with OnSong, you can learn more at our developer site located at http://onsongapp.com/developers

To send a message that flashes on the screen, you would use the "Call Hook" API command.  To do this, you POST a notification request to the following endpoint:

POST /api/<auth_token>/hooks

You then send a standard format that includes an OnSong notification name and userInfo for values like this:

{
  "name" : "SectionWasAdjusted",
  "userInfo" : {
    "amount" : 0.3333
  }
}

For sending messages, you would send something like this...

{
  "name" : "SongMessage",
  "userInfo" : {
    "tintColor" : "#009900",
    "duration" : 10,
    "message" : "Your message here..."
  }
}

Keep in mind that only the message part is required.  If you send a tintColor, then the text and background are set to that color.  You could also send textColor and backgroundColor if you want something different, but you would need to set the opacity of the background.  OnSong handles that by using 8 hexadecimal characters with the last two being the alpha.  To make green that's half opaque, you would use "#00990080".  The duration is also optional as OnSong will show a message for about 1/3 second per word.  You can change this default in settings, or you could set a specific time of your own.  The example would show the message for 10 seconds.