Message

Sending Push Messages to your Device

tyckr automatically registers all devices with Google’s Cloud Messaging service, enabling seamless delivery of push messages and notifications through a straightforward and simple HTTP API call.

API call

To send a push message, simply make an HTTPS GET or POST request using the following format:

https://api.tyckr.io/v1/push?tid={tid}&pin={pin}&title={title}&msg={message}&icon={icon}&image={image}&color={color}&slot={slot}

Parameters

Key

Mandatory

Description

tid

required

The 8-digit tyckr ID of the device.
You can find on your watch or widget in the configuration below About.

required

The 5-digit Push PIN.
The PIN can be found in the Face Editor under the corresponding Device’s Settings section, where you also have the option to change it.

title

required

The message title text.

msg

optional

The message body / content text.

icon

optional

An icon name to display an icon in the message, see the available Icon Facelet names.

image

optional

A valid image URL, which must be accessible by the device.

Important

The URL must be URL encoded. See the example below.

color

optional

Message title color in RRGGBB format like "FFA000" for Orange.
Defaults to "FFFFFF" for white.

slot

optional

Slot number (0-7), defaults to 0
Slot 0 is the default notification which appears in the notification centre.
Slot 1 - 7 are hidden messages which are accessible via the Push Notification Provider to be displayed in the face.

Response Codes

Code	Description
200	Message successfully sent to Cloud Messaging service. This is no guaranty that the message will be delivered to the device.
400	Format error.
401	Unauthorized, the tid or pin is wrong.
403	Forbidden, the IP is banned for 24h.
404	Device not found in database.
429	Too Many Requests, the daily quota is exceeded.
500	Server error, the device token has expired or any other server errors.

Examples

The shortest call is like:

https://api.tyckr.io/v1/push?tid=ABCDEFGH&pin=12345&title=This%20is%20a%20test%21

Send an image URL, like a still of a surveillance cam:

https://api.tyckr.io/v1/push?tid=ABCDEFGH&pin=12345&title=See%20this&image=https%3A%2F%2Fpicsum.photos%2F200

Important

Please ensure that all Notification permissions are enabled for tyckr on your device. Otherwise, you can’t see any tyckr notifications.

Push Message To Go

Send a test push message to your device: