Schemas

A human-readable reason. Not stable; branch on the status code.

On a schema 400, the first field at fault (dotted for nested fields).

Where the event happened — a bare id, or an id with a display name.

The member who acted. id is your chat's id for them, opaque to Hijinks and stable — scores and DMs follow it. name is shown in results and leaderboards; send it whenever you have it.

What followed the command, e.g. start, start science, leaderboard. Empty is help.

Optional. Your id for this request, unique per request; send the same one when you retry it. A request repeating an id seen in the last 24 hours is answered 202 and ignored.

Where the event happened — a channel as in Channel, or the member's own DM as dm:<user.id>, bare or with a display name.

The member who acted. id is your chat's id for them, opaque to Hijinks and stable — scores and DMs follow it. name is shown in results and leaderboards; send it whenever you have it.

The Hijinks message.id of the message the button was on.

The button's action, echoed back untouched.

Optional. Your id for this request, unique per request; send the same one when you retry it. A request repeating an id seen in the last 24 hours is answered 202 and ignored.

Where the event happened — a channel as in Channel, or the member's own DM as dm:<user.id>, bare or with a display name.

The member who acted. id is your chat's id for them, opaque to Hijinks and stable — scores and DMs follow it. name is shown in results and leaderboards; send it whenever you have it.

Optional. Your id for this request, unique per request; send the same one when you retry it. A request repeating an id seen in the last 24 hours is answered 202 and ignored.

The Hijinks message.id this replies to, when your chat has replies.

Opaque. Echo it back untouched; never parse it.

Minted by Hijinks. Keep a map from it to your chat's message id.

What the message is, so a bridge can special-case a few kinds and print the rest. text is a plain message with no buttons and no data; card is a generic message (confirmations, errors, celebrations, game announcements). New kinds may appear; print unknown ones like card.

Chat-flavoured Markdown, ready to print. A bare \n is a line break (see the API description). Always present; never empty for a message worth showing.

Rows of buttons, top to bottom, each row left to right. Empty when there are none.

An image or GIF to show with the message, or null.

Hijinks would like the member's next typed message to answer this one. Offer a reply box or thread if your chat has one, and send the answer as a message event with replyTo set. In a DM, replyTo is optional: a message with channel: "dm:<user id>" answers the latest prompt waiting there.

The platform-neutral view model the message was rendered from, for bridges that draw their own UI. Its shape depends on kind and is not part of the stable contract during the beta.

Unique per event and unchanged across its retries; dedupe on it.

The Hijinks workspace, as shown in the dashboard.

Strictly increasing per workspace, so events that arrive out of order can be put back in order (an older message.update than one already applied can be skipped). Not contiguous. Taken from Hijinks' clock in microseconds, so it keeps increasing across Hijinks restarts and deploys. Below 2^53, so it fits a JSON number in every language.

When Hijinks created the event (ISO 8601, UTC).

When the event goes stale (ISO 8601, UTC): past it, drop the event unapplied. 60 seconds after createdAt for message.ephemeral and ping; 10 minutes for a live game's messages and the answers to commands; null — never stale — for prompts and results that stay valid for hours (self-paced rounds, word games with their own end, icebreakers, digests). Compare it with your own clock.

A channel id your bridge sent in an inbound event — or dm:<user id> on a message.update of a message first sent by dm.create.

Unique per event and unchanged across its retries; dedupe on it.

The Hijinks workspace, as shown in the dashboard.

Strictly increasing per workspace, so events that arrive out of order can be put back in order (an older message.update than one already applied can be skipped). Not contiguous. Taken from Hijinks' clock in microseconds, so it keeps increasing across Hijinks restarts and deploys. Below 2^53, so it fits a JSON number in every language.

When Hijinks created the event (ISO 8601, UTC).

When the event goes stale (ISO 8601, UTC): past it, drop the event unapplied. 60 seconds after createdAt for message.ephemeral and ping; 10 minutes for a live game's messages and the answers to commands; null — never stale — for prompts and results that stay valid for hours (self-paced rounds, word games with their own end, icebreakers, digests). Compare it with your own clock.

A channel id your bridge sent in an inbound event — or dm:<user id> on a message.update of a message first sent by dm.create.

Unique per event and unchanged across its retries; dedupe on it.

The Hijinks workspace, as shown in the dashboard.

Strictly increasing per workspace, so events that arrive out of order can be put back in order (an older message.update than one already applied can be skipped). Not contiguous. Taken from Hijinks' clock in microseconds, so it keeps increasing across Hijinks restarts and deploys. Below 2^53, so it fits a JSON number in every language.

When Hijinks created the event (ISO 8601, UTC).

When the event goes stale (ISO 8601, UTC): past it, drop the event unapplied. 60 seconds after createdAt for message.ephemeral and ping; 10 minutes for a live game's messages and the answers to commands; null — never stale — for prompts and results that stay valid for hours (self-paced rounds, word games with their own end, icebreakers, digests). Compare it with your own clock.

A channel id your bridge sent in an inbound event — or dm:<user id> on a message.update of a message first sent by dm.create.

A member's user.id, as your bridge sent it.

Unique per event and unchanged across its retries; dedupe on it.

The Hijinks workspace, as shown in the dashboard.

Strictly increasing per workspace, so events that arrive out of order can be put back in order (an older message.update than one already applied can be skipped). Not contiguous. Taken from Hijinks' clock in microseconds, so it keeps increasing across Hijinks restarts and deploys. Below 2^53, so it fits a JSON number in every language.

When Hijinks created the event (ISO 8601, UTC).

When the event goes stale (ISO 8601, UTC): past it, drop the event unapplied. 60 seconds after createdAt for message.ephemeral and ping; 10 minutes for a live game's messages and the answers to commands; null — never stale — for prompts and results that stay valid for hours (self-paced rounds, word games with their own end, icebreakers, digests). Compare it with your own clock.

A member's user.id, as your bridge sent it.

Unique per event and unchanged across its retries; dedupe on it.

The Hijinks workspace, as shown in the dashboard.

Strictly increasing per workspace, so events that arrive out of order can be put back in order (an older message.update than one already applied can be skipped). Not contiguous. Taken from Hijinks' clock in microseconds, so it keeps increasing across Hijinks restarts and deploys. Below 2^53, so it fits a JSON number in every language.

When Hijinks created the event (ISO 8601, UTC).

When the event goes stale (ISO 8601, UTC): past it, drop the event unapplied. 60 seconds after createdAt for message.ephemeral and ping; 10 minutes for a live game's messages and the answers to commands; null — never stale — for prompts and results that stay valid for hours (self-paced rounds, word games with their own end, icebreakers, digests). Compare it with your own clock.

Oldest first; each exactly the envelope a push would have carried.

Pass as after on the next poll. The after you sent when no event was new. For after=latest, the newest cursor ("0" when the workspace has never held an event). Null only when you sent no after and nothing is held.

More events wait past this page; poll again at once.

Events after your after expired (24 hours) before you fetched them: the bridge missed something. Tell the channel if you like ("Hijinks was unreachable; some messages were missed") and carry on from next. Always false without after.