Applications and tokens

Create a bot in the Developer Portal, change its settings and install it in a server.

You will need

A Zrzur account. Sign up in the app if you have none. Bots have owners. An account can create 7 bots a week: each creation counts for 7 days, and deleting a bot does not give the creation back.

Create an application

An application and its bot are one thing: the application id, the bot id and the bot's user id are the same value.

1. Open the Developer Portal. It asks you to sign in. You also find it under Settings → Developer Portal.
2. Choose New application.
3. Enter a username for the bot. Read the bot rules, turn on the switch that says you accept them, then choose Create.
4. The token appears once. Copy it now and keep it safe: Zrzur stores only a fingerprint of it and cannot show it again.

The Overview tab

The Commands tab

Lists the bot's global commands. You can paste a JSON list there instead of registering from code. See Slash commands.

Install the bot in a server

A bot does nothing until it is in a server. The person who installs it needs Manage Server there. To give the bot permissions at the same time they also need Manage Roles and every permission they give.

The quickest way, for your own test server:

1. Open your application, tab Overview, and choose Add to a server.
2. Pick the server.

To install with chosen permissions, or to let others install it:

1. Open your application, tab OAuth2, part URL generator.
2. Tick bot.install and the permissions the bot needs.
3. Copy the Invite link and open it, or send it to the server's admin.
4. The person picks a server and confirms.

The permissions become a role named after the bot. Zrzur creates and manages that role: people can raise it, but they cannot delete it while the bot is there. Ask only for what the bot uses.

Reply to commands     nothing extra
Send messages         SendMessage, ViewChannel (members have these by default)
Moderate              KickMembers, BanMembers, TimeoutMembers, ManageMessages

The bot gets a role only if the link has permissions. With Add to a server it is a plain member with the server's default permissions.

After installing, move the bot's role above the members it should moderate. See Ranking.

Server limit and verification

An unverified bot can join 100 servers. After that installing fails with BotNeedsVerification. Past 100 servers it keeps only the privileged intents Zrzur approved. On the Overview tab, choose Verification and describe the bot. The same request as a call, for the owner, signed in:

curl -X POST "https://api.zrzur.com/bots/YOUR_BOT_ID/verification" \
  -H "x-session-token: YOUR_SESSION_TOKEN" \
  -H "content-type: application/json" \
  -d '{
    "statement": "Keeps notes and warnings for one gaming community.",
    "website": "https://example.com/bot",
    "support": "https://example.com/help",
    "privacy_policy_url": "https://example.com/privacy",
    "terms_of_service_url": "https://example.com/terms",
    "intents": 0
  }'

One request can be open at a time, and after a denial you can ask again a week later. GET /bots/{target}/verification answers verified, request with its status (Pending, Approved, Denied or Revoked), and can_apply_at.

Common errors

Next

• Start your bot
• Keeping tokens safe