The app directory

The app directory is where creators find chat bots and tools to add to their channel. It's public: anyone can browse it, signed in or not. Each entry has an Add to my channel button that opens your app's ordinary consent link, so the creator still sees every permission and decides.

How an app gets listed

An app is listed automatically while all three of these are true, and drops out as soon as one isn't:

  • Verified. Xive has reviewed it. Ask for a review from your app's page in the Console (Verification card). Public apps are also sent for review automatically once they reach 50 channels.
  • Public. The app's Public switch is on. A private app can only be on your own channel.
  • Active. It isn't suspended.

There's nothing to submit separately and no way to pay for a place. The Console's Directory listing card shows whether your app is listed, and what it still needs if it isn't.

Listing settings

On the same card you choose what your entry offers. Any role that can edit the app can change these:

  • Permissions for the Add button. The scopes the directory's consent link asks for. Ask only for what the app needs to work. With none ticked there's no Add button, only your website link.
  • Website (optional). An https:// page shown as Learn more: setup steps, commands, support.

Your entry also shows the app's name, icon, description and category, which you edit as usual. Changes reach the directory within about a minute.

What the directory shows

  • Your app's name, icon, description, category and a Verified badge.
  • Who makes it: your organization's name, or your @username for a personal app. Never an email address.
  • Roughly how many channels use it, in bands (Under 10, 10+, 25+, 50+, 100+ …). The exact number stays private, in your Console.
  • The permissions your Add button asks for, in the consent screen's words.

Directory API

The directory is also readable without authentication. Responses are cached for about a minute and rate-limited per IP address.

GET https://api.thexive.com/api/developer/directory?category=chat_bot&q=hype&page=1
GET https://api.thexive.com/api/developer/directory/{client_id}

The list returns apps (24 a page), total, has_more and categories (each with how many apps it lists). One app is { "app": { … } }, or a 404 when it isn't listed. Each app has:

{
  "client_id": "…",
  "name": "HypeBot",
  "description": "…",
  "icon_url": "https://…",
  "category": "chat_bot",
  "category_label": "Chat bot",
  "developer": { "kind": "organization", "name": "Night Owl Studios" },
  "verified": true,
  "channels": { "min": 50, "label": "50+" },
  "listing_scopes": [ { "scope": "chat:read", "label": "Read your chat" } ],
  "listing_url": "https://…",
  "add_url": "https://thexive.com/developers/authorize?client_id=…&scope=chat%3Aread",
  "url": "https://thexive.com/developers/apps/…"
}

From the Console's session, GET and PATCH /api/developer/apps/{id}/listing read and set the listing settings: {"scopes": ["chat:read", "chat:write"], "url": "https://…"}. Send "url": null to remove the website.