discord/discord-api-docs

Features

• API Documentation - Serves as the official reference documentation for the Discord API covering bots, webhooks, and gateway events.
• Bot Platforms - Creates automated users that join servers, listen to events, and respond to interactions via the Discord API.
• Bot Registration Managers - Documents how to register a bot, generate tokens, and create OAuth2 invitation URLs for server integration.
• Text Channel Lifecycles - Provides API endpoints for creating, editing, deleting, and reordering text channels and threads.
• Slash Command Interfaces - Processes slash-prefixed commands by receiving interaction payloads and returning messages or modals.
• Bot Building - Creates automated applications that run inside Discord servers to respond to commands and events.
• Webhook Notification Channels - Sends messages to Discord channels via HTTP POST webhooks without a persistent bot connection.
• Verified Game Communities - Provides API endpoints for assigning verified badges to game community servers.
• Websocket Connection Managers - Maintains a persistent WebSocket connection to receive real-time events and send commands to Discord.
• Discord Integrations - Provides the official API and documentation for building Discord bots with slash commands and interactions.
• Snowflake-ID Pagination - Provides cursor-based pagination using snowflake IDs for navigating Discord API result sets.
• Message Posting and Retrieval - Provides API endpoints for posting new messages and reading message history in channels.
• Rich Embed Messages - Posts formatted messages containing structured content like images, fields, and links into a channel.
• Gateway Interaction Reception - Ships a gateway WebSocket protocol for receiving interaction payloads and real-time events from Discord.
• Persistent WebSocket Gateways - Maintains a persistent WebSocket connection for real-time event reception and command sending.
• Bot Authentication Strategies - Ships a bot authentication strategy using tokens passed in the Authorization header.
• Administrative Role Management - Provides API endpoints for creating, updating, deleting, and assigning roles to members.
• OAuth2 Implementations - Implements OAuth2-based authentication for authorizing API requests and managing user permissions.
• OAuth2 Providers - Provides an OAuth2 provider for authenticating API requests with bearer tokens.
• Discord Identity Providers - Provides OAuth2 authentication flows for authorizing API requests and managing user permissions with Discord.
• Webhook Event Notifications - Subscribes to Discord events and receives signed HTTP POST notifications at a public endpoint.
• Event Webhook Management - Subscribes to Discord events so the platform pushes signed HTTP POSTs to a public endpoint.
• Webhook Integrations - Provides a webhook system for sending messages and receiving event notifications via HTTP POST requests.
• Discord Server Administrators - Documents APIs for automating server administration tasks like channel management and role assignment.
• Interaction Models - Processes user actions on buttons, select menus, and modals by receiving interaction payloads and returning responses.
• Interactive Message Components - Provides interactive message components like buttons and select menus embedded in chat messages.
• Interactive Component Embeds - Embeds interactive UI elements like buttons and select menus directly into messages sent by the app.
• User Interaction Handling - Responds to slash commands, context menus, buttons, select menus, and modals triggered by users.
• Interaction Webhook Receivers - Receives interaction payloads via HTTP POST with signature validation for secure processing.
• Webhook Interaction Reception - Implements HTTP interaction reception with signature validation and ping handshake for Discord app endpoints.
• Embedded App SDK Bridges - Bridges data between iframe-based activities and the Discord client via a JavaScript SDK.
• Real-Time Communication Protocols - Provides a persistent WebSocket protocol for receiving real-time events and sending commands to Discord servers.
• Interactive Interaction Handling - Processes user actions on buttons, select menus, and modals by receiving interaction payloads and returning responses.
• Discord Workflow Automation - Automates scheduled and event-driven tasks that integrate Discord with external services.
• Discord Commerce Integrations - Documents how to sell subscriptions and one-time purchases using Discord's built-in payment flows.
• Discord Purchase Integrations - Documents how to integrate Discord's built-in payment flow to sell subscriptions and one-time purchases.
• Member Profile Management - Provides API endpoints for fetching member details, modifying nicknames, and managing timeouts.
• Webhook-Triggered Fulfillment - Documents how to receive webhook events on completed purchases and grant items automatically.
• Member Removers - Provides API endpoints for removing members from servers permanently or temporarily.
• Embedded App SDKs - Provides an SDK for building interactive activities and multiplayer experiences that run inside the Discord client.
• Official Community Claimers - Documents how to link a game to a verified community server with vanity URLs and store-page discoverability.
• In-Chat Activities - Hosts multiplayer games and social experiences that users start directly inside a Discord channel.
• Server Metadata APIs - Provides API endpoints for reading server name, icon, member count, and feature flags.
• Companion App Engagement - Uses a bot to announce in-game events, share achievements, and run promotions for player retention.
• Social Presence Integration - Integrates rich presence, voice chat, and social capabilities into a game across multiple platforms.
• Game Community Managers - Documents how to create official game communities with verified servers and store-page discoverability.
• Embedded App SDKs - Uses an Embedded App SDK to exchange data between iframe-based Activities and the Discord client.
• In-App Purchases - Provides an in-server store for browsing, purchasing, and receiving game items without leaving Discord.
• Embedded Multiplayer Activities - Embeds multiplayer games and social experiences directly in Discord so users play together without leaving the client.
• Game Activity Presence - Provides API endpoints for displaying game activity with custom text, images, and join links.
• Automated Moderation - Automates server management tasks such as enforcing rules, filtering content, and managing members.
• Channel Permission Overrides - Provides API endpoints for overriding channel permissions for specific members or roles.
• Game - Creates official game servers for player connection, feedback, and engagement between updates.
• Community Server Management - Sets up Discord servers with structured onboarding, announcements, and moderation tools for public audiences.
• Context Menu Command Handlers - Documents how to process commands triggered from context menus on messages or user profiles.
• Modal Overlays - Displays focused form overlays to collect multi-field input through text fields in response to user interactions.
• App Directory Listings - Lists verified apps in a searchable directory for user browsing and installation.
• App Discovery Listings - Submits bots to an app directory and launcher for user discovery and installation.
• App Launcher Surfacing - Surfaces recently used and curated apps in a panel accessible from a platform icon.
• Social App Discovery - Enables app discovery through social interactions and sharable links within the platform.

Star history