yappy docs Portal

yappy developer documentation

yappy is a group-first chat platform with a real bot API: token auth, rich embeds, message components, slash commands, and signed webhooks. Everything a first-party feature can do, a third-party bot can do with an HTTPS request.

Start here

Reference

Conventions across the docs

  • Errors are always { "error": { "code", "message", "details?", "retryAfter?" } }. Switch on code, never on message. Messages are copy and will change.
  • Permission bitfields travel as decimal strings, because the field runs past the 2^53 limit of a JavaScript number. Parse them as big integers.
  • A bot token is sent as Bot, not Bearer. The two schemes are not interchangeable and each is rejected where it does not belong.
  • Sending a message requires a nonce. It is your idempotency key, and it is what makes a retry after a dropped connection safe.