Discord RPC

Discord contains multiple methods of RPC communication to send messages to locally running Discord clients, allowing the remote execution of specific commands to interface with the client. This powers functions you may be familiar with, like clicking an invite link in the browser prompting the locally running Discord client to open with the invite modal.

This page documents the entire RPC protocol. It can be used to help interface with the official Discord client, or as a reference document to implement your own client that supports the RPC protocol.

RPC Protocol Version

The current and only supported version of the RPC protocol is 1.

RPC Transports

RPC supports four different transports:

RPC Scopes

Architecturally, RPC uses the same scopes as OAuth2. The following pseudoscopes below are inherent to the protocol itself, and do not exist as real scopes in the API.

RPC Close Codes

Close codes will either be received as a WebSocket close frame or a protocol-level CLOSE opcode. They will be accompanied by a human-friendly message describing the reason for the close.

RPC Errors

Errors will be dispatched as a ERROR event in response to an outgoing command. They will be accompanied by a human-friendly message describing the error.

Example RPC Error

{
  "code": 4000,
  "message": "Invalid Client ID"
}

Rate Limits

The Discord RPC server has a per-client rate limit of 2 connections per minute. This rate limit is raised to 60 connections per minute on Canary clients, as well as clients connecting over the PostMessage transport. Connections exceeding this limit will have a delay before processing.

WebSocket Transport

All Discord clients have an RPC server running that allows control over local Discord clients. The local RPC server runs on localhost (127.0.0.1) and is set up to process WebSocket connections and proxy API requests.

Connecting

For WebSocket connections, the connection is always in the form of ws://127.0.0.1:PORT/. discordapp.io may also be used as it always resolves to localhost.

The port range for Discord's local RPC server is [6463, 6472]. Since the RPC server runs locally, there's a chance it might not be able to obtain its preferred port when it tries to bind to one. For this reason, the local RPC server will pick one port out of a range of these 10 ports, trying sequentially until it can bind to one. For multiple clients (e.g. Stable and Canary), you might want to add a feature to manually select the port so you can more easily debug.

The below query string parameters should be appended to the connection URL.

Query String Params

¹ Can only be omitted when connecting from a Discord-controlled Origin.

² ETF encoding may not be supported by all clients. If ETF encoding is requested, outgoing packets must also be sent in the ETF format.

Sending and Receiving Packets

Packets are sent as JSON objects containing the command you want to send to the Discord client. Incoming packets will need to be correctly parsed to obtain the JSON response.

Authentication

Upon connection, the RPC server will validate your provided client_id. If the connection is from a non-Discord-controlled Origin and the client_id is missing, the server will immediately disconnect. Otherwise, the server will attempt to fetch the client application using the Get RPC Application endpoint. If the application is not found, or the Origin header of the connection does not match one of the application's rpc_origins values, the server will disconnect. Only if the application is found and the Origin header matches an rpc_origins value will the connection will be accepted.

Upon a successful connection, the server will send a READY event containing some basic user information and configuration data. At this point, you can send an AUTHORIZE command to obtain an OAuth2 code, which can then be exchanged for an access token.

Usage

When connecting from a browser, the WebSocket transport can only be used by Discord itself and a select few trusted partners, as the WebSocket transport allows controlling the client without having software installed on the user's machine.

For example, upon certain events, like clicking an invite link from a browser, Discord will open a WebSocket connection to the local RPC server, sending the INVITE_BROWSER command:

Example Invite Browser Payload

{
  "cmd": "INVITE_BROWSER",
  "args": {
    "code": "fortnite"
  },
  "nonce": "5c283c7d-524a-4090-b04b-ea0fb023e44c"
}

Example Invite Browser Response

The local client will receive and use the information from this response to display the invite modal, and respond with:

{
  "cmd": "INVITE_BROWSER",
  "data": {
    "invite": {
      "type": 0,
      "code": "fortnite",
      "expires_at": null
      // ...
    },
    "code": "fortnite"
  },
  "evt": null,
  "nonce": "5c283c7d-524a-4090-b04b-ea0fb023e44c"
}

HTTP Transport

The HTTP transport is a subset of the WebSocket transport meant for one-off commands that do not require a long-lived connection.

Connecting

The HTTP transport is available on the same port range as the WebSocket transport. The connection URL is in the form of http://127.0.0.1:PORT/rpc.

The below query string parameters still apply.

Query String Params

¹ Can only be omitted when connecting from a Discord-controlled Origin.

Sending and Receiving Packets

Clients should send a POST request to the connection URL with a JSON body containing the command you want to send. The server will respond with a JSON object containing the response of the command.

An even more limited transport is available via a GET request, where authentication is entirely bypassed, and client_id can be omitted. However, this only grants the rpc.private.limited scope, which only allows a select few commands that don't require authenticated scopes. For this transport, a JSON-encoded payload query string parameter should be sent alongside the request, containing the same JSON object as the body of a POST request. A callback query string parameter may also be sent, to specify where the response should redirect to. If the callback is not provided, or does not match the server's origin, the server will use the default marketing URL instead. This is intended for internal use by Discord's web client, and should not be used by third parties.

Authentication

The authentication process for the HTTP transport is the same as the WebSocket transport, with one crucial difference: if no Origin header is present, the rpc_origins check will be bypassed and the connection will be accepted as long as the client_id is valid. This allows this transport to be used by anyone outside of a browser context.

However, as the HTTP transport can only be used for one-off commands, you will be unable to complete the typical RPC handshake. This limits the use of this transport to only commands that don't require authenticated scopes.

IPC Transport

Similarly, all Discord clients also have an IPC server running that allows control over local Discord clients. By sending packets through the Discord RPC IPC pipe, you can programmatically control your local Discord client, like joining voice channels, retrieving guild or user information, and more.

Connecting

Discord can be on any pipe ranging from discord-ipc-0 to discord-ipc-9. It is a good idea to try and connect to each one and keeping the first one you successfully connect to. For multiple clients (e.g. Stable and Canary), you might want to add a feature to manually select the pipe so you can more easily debug.

On Windows, the Discord IPC pipe format is \\\\?\\pipe\\discord-ipc-0. On macOS & Linux, it'll be kept in the folder indicated by the XDG_RUNTIME_DIR, TMPDIR, TMP or TEMP envvars. If none of those exist, use /tmp/.

Sending and Receiving Packets

The IPC protocol has an additional of abstraction over the typical JSON payloads used in the WebSocket transport.

Packets are sent as binary data in a simple format composed of an 8-byte header and payload. The header consists of two 32-bit unsigned integers (little endian) representing the opcode and payload length.

IPC Opcodes

Packet Structure

Example Packet

00000000  28000000  7B2276223A312C22 (trimmed)
^^^^^^^^  ^^^^^^^^  ^^^^^^^^^^^^^^^^
OPCODE 0   Length    Payload
HANDSHAKE  40 bytes  { "v" : 1, "

Authentication

After connecting to the IPC socket, you should immediately send a handshake packet to the server. The server will respond with a FRAME packet containing the READY event with some basic user information and configuration data. Upon successful reception of this event, you can send an AUTHORIZE command to obtain an OAuth2 code, which can then be exchanged for an access token. Once authenticated, you can call RPC commands on behalf of the user!

Handshake Structure

Close Structure

PostMessage Transport

The PostMessage transport is meant for embedded activities to communicate with the client from within an iFrame.

Connecting

The PostMessage transport does not require an actual connection, as messages will be sent to the parent window using window.postMessage.

Sending and Receiving Packets

The PostMessage transport uses a similar abstraction layer to the IPC transport.

Packets are sent as an array of two elements, the first being the integer opcode, and the second being the payload object. Opcodes follow the same values as the IPC transport.

Authentication

Similarly to IPC, you should immediately send a handshake message to the parent window after the iFrame loads. Then, the client will validate that the message is coming from a valid embedded activities origin, typically https://<client_id>.discordsays.com.

The parent window will respond with a READY event containing some basic user information and configuration data. Upon successful reception of this event, you can send an AUTHORIZE command to obtain an OAuth2 code, which can then be exchanged for an access token. Once authenticated, you can call RPC commands on behalf of the user!

Handshake Structure

Packet Payloads

Packet payloads are JSON objects containing the command you want to send to the Discord client. Incoming packets will need to be correctly parsed to obtain the JSON response.

Outgoing Payload Structure

¹ Only required when cmd is SUBSCRIBE or UNSUBSCRIBE.

Incoming Payload Structure

¹ Only present in DISPATCH, SUBSCRIBE, and UNSUBSCRIBE events.

RPC User Object

See the user resource for more information.

RPC User Structure

RPC Guild Object

See the guild resource for more information.

RPC Guild Structure

¹ Only available in Get Guild response.

RPC Guild Member Object

See the guild resource for more information.

RPC Guild Member Structure

Partial RPC Guild Member Structure

RPC Channel Object

See the channel resource for more information.

RPC Channel Structure

¹ Only included if the channel or guild's application_id matches the client_id of the connection, or the authorization has the messages.read scope.

Partial RPC Channel Structure

RPC Message Object

See the message resource for more information.

RPC Message Structure

RPC Voice State Object

RPC Voice State Structure

RPC Remote Voice State Structure

Pan Structure

RPC Relationship Object

RPC Relationship Structure

RPC Relationship Presence Structure

RPC Voice Settings Object

RPC Voice Settings Structure

RPC Voice IO Settings Structure

Available Device Structure

RPC Voice Settings Mode Structure

RPC Voice Settings Mode Type

Shortcut Key Combo Structure

¹ This field is always present when received.

Shortcut Key Combo Type

RPC Guild Template Object

RPC Guild Template Structure

¹ This partial guild object is special in that it and the objects within always contain applicable optional fields (even if they're not applicable). This leads to unexpected behavior, such as available_tags being serialized for voice channels. Additionally, the main guild object is missing the id field, and all other id fields are not real snowflakes.

RPC Guild Template State

Certified Device Object

Certified Device Structure

¹ Only applicable if the type is audioinput.

Certified Device Type

Certified Device Vendor Structure

Certified Device Model Structure

RPC Activity Participant Object

RPC Activity Participant Object

This structure is a superset of the RPC user object with the following additional fields:

Orientation State

RPC Commands

Commands are the means in which an application can interface with the client.

¹ If retrieving a private channel, also requires the rpc or dm_channels.read scope.

² Not available from http transport.

Authorize

Used to authorize the current client with your application.

Authorize Arguments Structure

¹ Required unless the basic bot authorization flow is used.

² If a response_type is specified and no redirect_uri is specified, the user will be redirected to the first registered redirect URI for the application.

³ Only applicable if using the ws transport.

Authorize Response Structure

Authenticate

Used to authenticate an existing client with your app.

Authenticate Arguments Structure

Authenticate Response Structure

This structure is a superset of the Get Current Authorization Information response with the following additional fields:

Subscribe

Used to subscribe to an RPC event. Accepts event subscription arguments. The outer evt field is used as the event name to subscribe to.

Subscribe Response Structure

Unsubscribe

Used to unsubscribe from an RPC event. Accepts event subscription arguments. The outer evt field is used as the event name to unsubscribe from.

Unsubscribe Response Structure

Get Guild

Used to retrieve guild information from the client. Responds with an RPC guild object.

Get Guild Arguments Structure

Get Guilds

Used to retrieve a list of guilds from the client. Responds with a list of RPC guild objects.

Get Channel

Used to retrieve channel information from the client. Responds with an RPC channel object.

Get Channel Arguments Structure

Get Channels

Used to retrieve a list of channels for a guild from the client.

Get Channels Arguments Structure

Get Channels Response Structure

Get Channel Permissions

Used to retrieve the permission settings for the currently connected voice channel.

Get Channel Permissions Response Structure

Create Channel Invite

Used to create an invite link for a given channel. Responds with a invite object (with invite metadata).

Create Channel Invite Arguments Structure

Get Relationships

Used to retrieve the friend list and relationship statuses.

Get Relationships Response Structure

Get User

Used to retrieve information about a specific user. Responds with an RPC user object or null.

Set User Voice Settings

Used to change voice settings of users in a voice channel. Responds with the resolved settings.

Set User Voice Settings Arguments Structure

Set User Voice Settings 2

Used to change voice settings of users in a voice channel. Responds with null.

Set User Voice Settings Arguments Structure

Push To Talk

Used to enable or disable push-to-talk functionality. Responds with null.

Push To Talk Arguments Structure

Select Voice Channel

Used to join or leave a voice channel, group DM, or DM. Responds with an RPC channel object or null.

Select Voice Channel Arguments Structure

Get Selected Voice Channel

Used to get the current voice channel the client is in. Responds with an RPC channel object or null.

Select Text Channel

Used to join or leave a text channel, group DM, or DM. Responds with an RPC channel object or null.

Select Text Channel Arguments Structure

Get Voice Settings

Used to retrieve the client's voice settings. Responds with an RPC voice settings object.

Set Voice Settings

Used to set the client's voice settings. Responds with an RPC voice settings object.

Set Voice Settings Arguments Structure

Partial RPC Voice Settings Mode Structure

Set Voice Settings 2

Used to set the client's voice settings. Responds with null.

Set Voice Settings 2 Arguments Structure

RPC Voice Input Mode Structure

Set Activity

Used to update a user's rich presence. Responds with an activity object.

Set Activity Arguments Structure

¹ Only required for the ipc transport.

RPC Activity Structure

RPC Activity Party Structure

Activity Party Privacy

RPC Activity Button Structure

Send Activity Join Invite

Used to send an invite to another user for an activity. Responds with null.

Send Activity Join Invite Arguments Structure

Close Activity Join Request

Used to reject a rich presence Ask to Join request. Responds with null.

Close Activity Join Request Arguments Structure

Activity Invite User

Used to send an invite to another user for an activity. Responds with null.

Send Activity Join Invite Arguments Structure

Accept Activity Invite

Used to accept an activity invite. Responds with null.

Accept Activity Invite Arguments Structure

Open Invite Dialog

Used to present a modal to invite other users to the current embedded activity. Responds with null.

Open Share Moment Dialog

Used to share an image from an embedded activity in recent DMs or channels. Responds with null.

The application must have the EMBEDDED flag.

Open Share Moment Dialog Arguments Structure

Share Interaction

Used by embedded activities to present a modal to user asking where a pre-defined slash command should be ran.

The content, preview_image, and components fields are used within the modal as a command response preview.

Share Interaction Arguments Structure

¹ Only action rows are permitted. Only buttons are permitted inside action rows. The buttons can have only type, style, label, and custom_id. PREMIUM buttons are not permitted. The components can't have id field set.

Interaction Option Structure

Interaction Response Preview Image Structure

Share Interaction Response Structure

Initiate Image Upload

Used by embedded activities to open a file dialog and retrieve a user-provided image.

Initiate Image Upload Response Structure

Share Link

Used to open the share message modal, where a user can pick a channel to send a developer-defined message to.

The application must have the EMBEDDED flag.

Share Link Arguments Structure

Share Link Response Structure

Deep Link

Used to navigate to a route in the Discord client.

Deep Link Arguments Structure

Deep Link Type

Deep Link Params Structure

¹ A special value of @me is used to indicate private channels.

Quest Home Sort Type

Quest Home Filter Type

Quest Home Tab

Connections Callback

Used to send the next part of connection flow to the client. Responds with null.

Connections Callback Arguments Structure

Billing Popup Bridge Callback

Used as callback for payment methods like PaySafeCard, Klarna, Przelewy24, and other payment providers.

Billing Popup Bridge Callback Arguments Structure

Billing Popup Bridge Callback Response Structure

Gift Code Browser

Used to open a given gift code link in the client.

Gift Code Browser Arguments Structure

Gift Code Browser Response Structure

Guild Template Browser

Used to open a given template link in the client.

Guild Template Browser Arguments Structure

Guild Template Browser Response Structure

Open Message

Used to open a specific message or DM in the client. Responds with null.

Open Message Arguments Structure

Browser Handoff

Used to end browser handoff. Responds with null.

Browser Handoff Arguments Structure

Set Certified Devices

Used to send info about certified hardware devices. Responds with null.

Set Certified Devices Arguments Structure

Get Image

Used to fetch a user's profile picture.

Get Image Arguments Structure

Image Type

Get Image Response Structure

Set Overlay Locked

Used to set whether the overlay input is locked. Responds with null.

Set Overlay Locked Arguments Structure

Open Overlay Activity Invite

Used to open the activity invite modal in the process' overlay. The activity set via SET_ACTIVITY command must have party and join secret. Responds with null.

Open Overlay Activity Invite Arguments Structure

Open Overlay Guild Invite

Used to open the invite modal in the process' overlay.

Open Overlay Guild Invite Arguments Structure

Open Overlay Voice Settings

Used to open a voice settings modal in the process' overlay.

Open Overlay Voice Settings Arguments Structure

Validate Application

Used to validate the application. Responds with null if the user has entitlement for primary application's SKU.

Get Entitlement Ticket

Used to retrieve the entitlement ticket for the current application.

Get Entitlement Ticket Response Structure

Get Application Ticket

Used to retrieve the application ticket for the current application.

The ticket usually can be validated client-side with following pseudocode:

import base64
import json
from nacl.signing import VerifyKey
from nacl.exceptions import BadSignatureError

# Your public key can be found on your application in the Developer Portal
PUBLIC_KEY = 'APPLICATION_PUBLIC_KEY'
SKU_ID = '12345678912345678912'

def validate_application_ticket(ticket: str, *, public_key: str) -> Optional[dict]:
    verify_key = VerifyKey(public_key)
    parts = ticket.split('.')

    if len(parts) < 3:
        # Not enough parts
        return None

    if parts[0] != '2':
        # Invalid ticket version
        return None

    try:
        signature = bytes.fromhex(parts[1])
    except ValueError:
        # Invalid ticket signature
        return None

    encoded_data = parts[2]
    try:
        verify_key.verify(encoded_data, signature)
    except BadSignatureError:
        # The ticket is tampered with
        return None

    data = json.loads(base64.decode(encoded_data))
    return data

ticket = ''
validated = validate_application_ticket(ticket)

if validated is None:
    print('The ticket is invalid')
else:
    entitlements = validated['entitlements']
    has_entitlement = any(entitlement['sku_id'] == SKU_ID for entitlement in entitlements)

    if has_entitlements:
        print('The ticket is valid and the player has entitlement')
    else:
        print('The ticket is valid, but the player does not have entitlement')

Get Application Ticket Response Structure

Start Purchase

Used to launch the purchase flow for a specific SKU. Responds with a list of purchased entitlement objects.

Start Purchase Arguments Structure

Start Premium Purchase

Used to initiate a premium subscription purchase.

Start Premium Purchase Arguments Structure

Get SKUs

Used to retrieve a list of your application's SKUs. Responds with a list of SKU objects.

Get Entitlements

Used to retrieve a list of entitlements for the current user. Responds with a list of entitlement objects.

Get SKUs Embedded

Used to retrieve a list of your application's SKUs in an embedded context.

Get SKUs Embedded Response Structure

Get Entitlements Embedded

Used to retrieve a list of entitlements for the current user in an embedded context.

Get Entitlements Embedded Response Structure

Get Networking Config

Used by the GameSDK to retrieve a proxy address and networking token.

Get Networking Config Response Structure

Networking System Metrics

Used by the GameSDK to send networking system metrics. Accepts an object.

Networking Peer Metrics

Used by the GameSDK to send networking peer metrics. Accepts an object.

Networking Create Token

Used by the GameSDK to retrieve a networking token.

Networking Create Token Response Structure

User Settings Get Locale

Used to retrieves the client’s locale.

User Settings Get Locale Response Structure

Send Analytics Event

Used to send an analytics event to Discord via embedded activity. Responds with null.

The application must have the EMBEDDED_FIRST_PARTY flag.

Send Analytics Event Arguments Structure

Open External Link

Used to prompt to open a given URL in the default web browser. Responds with null.

Open External Link Arguments Structure

Capture Log

Used to capture a log entry in the client's console. Responds with null.

Capture Log Arguments Structure

Log Level

Encourage HW Acceleration

Used to encourage users to turn on hardware acceleration. Accepts an empty object. Responds with null.

Set Orientation Lock State

Used to set options for orientation and picture-in-picture (PiP) modes. Responds with null.

Set Orientation Lock State Arguments Structure

Get Platform Behaviors

Used to retrieve platform-specific behaviors. Response is unstable and subject to change.

Get Platform Behaviors Response Structure

Get Soundboard Sounds

Used to retrieve available soundboard sounds. Responds with a list of soundboard sound objects. Note that default sounds may have their guild_id set to 0.

Play Soundboard Sound

Used to play a soundboard sound. Responds with null.

Play Soundboard Sound Arguments Structure

Toggle Video

Used to toggle video in a call. Responds with null.

Toggle Screenshare

Used to toggle screenshare in a call. Responds with null. If process ID is not provided, this will present a screenshare modal.

Toggle Screenshare Arguments Structure

Get Activity Instance Connected Participants

Used to retrieve users connected to a specific activity session.

Get Activity Instance Connected Participants Response Structure

Get Provider Access Token

Used for the Amazon Music activity to authorize the connection and retrieve the access token. If the user does not have connection for the provider, the Discord client will open a window to link the account to Discord.

Get Provider Access Token Arguments Structure

Get Provider Access Token Response Structure

Maybe Get Provider Access Token

Used for the Amazon Music activity to attempt to get the access token from existing connection.

Maybe Get Provider Access Token Arguments Structure

Maybe Get Provider Access Token Response Structure

Navigate To Connections

Used for Amazon Music, opens the connections page in settings. Accepts an empty object. Responds with null.

Invite User Embedded

Used to invite a user to the current embedded activity.

Invite User Embedded Arguments Structure

Invite Browser

Used to open an invite modal for a guild invite in the client.

Invite Browser Arguments Structure

Invite Browser Response Structure

Request Proxy Ticket Refresh

Used to refresh proxy tickets for the current embedded activity.

The application must have the EMBEDDED flag.

Request Proxy Ticket Response Structure

Get Quest Enrollment Status

Used to retrieve enrollment status for a quest.

Get Quest Enrollment Status Arguments Structure

Get Quest Enrollment Status Response Structure

Quest Start Timer

Used to start timer for a quest.

Quest Start Timer Arguments Structure

Quest Start Timer Response Structure

RPC Events

Events are payloads sent over the socket to a client that correspond to events in Discord. Many of these mirror actual Gateway events, so check there for more details!

¹ Requires that the channel or guild's application_id matches the client_id of the connection, or the authorization has the messages.read scope.

Ready

Sent when the client has completed the initial handshake with the RPC server.

Ready Structure

¹ Only present in the IPC transport.

Client Environment Config Structure

Error

Sent in response to outgoing command or event.

Error Structure

Current User Update

Sent when properties about the current user change. Inner payload is an RPC user object.

Current Guild Member Update

Sent when properties about the guild member change. Inner payload is an RPC guild member object.

Current Guild Member Update Subscription Arguments Structure

Guild Status

Sent when a subscribed guild's state changes.

Guild Status Subscription Arguments Structure

Guild Status Structure

Guild Create

Sent when a guild is created/joined on the client. The inner payload is an RPC guild object.

Channel Create

Sent when a channel is created/joined on the client. The inner payload is a partial RPC channel object.

Relationship Update

Sent when a user's relationship updates. The inner payload is an RPC relationship object.

Voice Channel Select

Sent when the client moves voice channels.

Voice Channel Select Structure

Voice State Create

Sent when a user joins a subscribed voice channel. The inner payload is an RPC voice state object.

Voice State Create Subscription Arguments Structure

Voice State Delete

Sent when a user parts a subscribed voice channel. The inner payload is an RPC voice state object.

Voice State Delete Subscription Arguments Structure

Voice State Update

Sent when a user's voice state changes in a subscribed voice channel (mute, volume, etc.). The inner payload is an RPC voice state object.

Voice State Update Subscription Arguments Structure

Voice Settings Update

Sent when the client's voice settings update. The inner payload is an RPC voice settings object.

Voice Settings Update 2

Sent when the client's user voice settings update.

Voice Settings Update 2 Structure

RPC Voice Input Mode Structure

Voice Connection Status

Sent when the client's voice connection status changes.

Voice Connection Status Structure

Voice Connection Ping Structure

Voice Connection State

Speaking Start

Sent when a user in a subscribed voice channel speaks.

Speaking Start Subscription Arguments Structure

Speaking Start Structure

Speaking Stop

Sent when a user in a subscribed voice channel stops speaking.

Speaking Stop Subscription Arguments Structure

Speaking Stop Structure

Activity Join

Sent when the user clicks a rich presence join invite in chat to join an activity.

Activity Join Structure

Join Intent

Activity Join Request

Sent when the user receives a rich presence Ask to Join request.

Activity Join Request Structure

Activity Spectate

Sent when the user clicks a rich presence spectate invite in chat to spectate a game.

Activity Spectate Structure

Activity Invite

Sent when the user receives a rich presence Join request.

Activity Invite Structure

Activity PiP Mode Update

Sent when PiP (Picture-in-Picture) mode changes. This is essentially equivalent to Activity Layout Mode Update and checking if layout mode is not FOCUSED.

Activity PiP Mode Update

Activity Layout Mode Update

Sent when a user changes the layout mode in the Discord client.

Activity Layout Mode Update Structure

Layout Mode

Thermal State Update

Sent when thermal state of mobile device is updated.

Thermal State Update Structure

Thermal State

Orientation Update

Sent when orientation of the screen changes.

Orientation Update Structure

Activity Instance Participants Update

Sent when someone joins/leaves embedded activity instance.

Activity Instance Participants Update Structure

Notification Create

Sent when the client receives a notification (mention or new message in eligible channels).

Notification Create Structure

Message Create

Sent when a message is created in a subscribed text channel.

Message Create Subscription Arguments Structure

Message Create Structure

Message Update

Sent when a message is updated in a subscribed text channel.

Message Update Subscription Arguments Structure

Message Update Structure

Message Delete

Sent when a message is deleted in a subscribed text channel.

Message Delete Subscription Arguments Structure

Message Delete Structure

Partial RPC Message Structure

Overlay Update

Sent when the game overlay settings are changed for your application.

Overlay Update Subscription Arguments Structure

Overlay Update Structure

Entitlement Create

Sent when an entitlement is created when a user purchases or is otherwise granted one of your application's SKUs. The inner payload is an entitlement object.

Entitlement Delete

Sent when an entitlement is deleted. The inner payload is an entitlement object.

Screenshare State Update

Sent when a user's screenshare state changes.

Screenshare State Update Structure

Screenshare Application Structure

Video State Update

Sent when a user's video state changes.

Video State Update Structure

Authorize Request

Sent when an activity wants to authorize within the Discord client. Inner payload is null.

Quest Enrollment Status Update

Sent when a user's quest enrollment status changes.

Quest Enrollment Status Update Structure