Private beta: this contract may change before launch. Join the waitlist
Hijinks
Guides

What a bridge sends us

A bridge runs on your servers, so you decide what reaches Hijinks. This is what the contract asks for and what the reference bridge sends. The privacy policy covers how we keep and erase it.

From your bridge to Hijinks

  • Chat ids. The id of the channel (and its display name, if the bridge sends one) and the id of the member who acted. Ids are your chat's own opaque strings.
  • Display names. The member's name as your chat shows it, so standings read "Maya K." rather than an id.
  • Commands. The text after /hijinks, for example start or celebrations birthday 04-12.
  • Button presses. Which button, on which Hijinks message. Nothing else about the message.
  • Typed messages, if you turn them on. For word games and typed answers, the reference bridge forwards every message posted in the game channel, with its author's id and name, and the messages members type in their direct messages with the bot. Hijinks ignores and does not keep a message that is not an answer. Leave the outgoing webhook out and nothing typed is forwarded: word games then take guesses only as commands (/hijinks answer, guess or letter). Use a channel just for games.

A bridge never sends email addresses, avatars, channel history or member lists. The reference bridge sends nothing it is not listed above.

From Hijinks to your bridge

What to post, and nothing more: the text of each game message, its buttons, an optional image link (a question's GIF) and, for bridges that draw their own UI, the data the message was drawn from, such as the question, the answer count and the standings by display name. Messages are addressed to a channel id, or to a member id for a direct message or a reply only they see.

Both directions are signed with your workspace's secret. Push mode sends events to your bridge's HTTPS address; polling keeps them for 24 hours until your bridge fetches them, then deletes them.

What Hijinks keeps

The same as on any other chat: members' ids and display names, game answers and scores, celebration dates members set, Know Your Team answers, and settings. Disconnecting the workspace in the dashboard stops all traffic at once and erases its data after 30 days.

Last modified on