# Table of Contents
- [Introduction | Push Chat | Push Documentation](#introduction-push-chat-push-documentation)
- [Message Type - Text | Push Chat | Push Documentation](#message-type-text-push-chat-push-documentation)
- [Intro to Message Types | Push Chat | Push Documentation](#intro-to-message-types-push-chat-push-documentation)
- [Message Type - File | Push Chat | Push Documentation](#message-type-file-push-chat-push-documentation)
- [Message Type - Image | Push Chat | Push Documentation](#message-type-image-push-chat-push-documentation)
- [Message Type - Meta | Push Chat | Push Documentation](#message-type-meta-push-chat-push-documentation)
- [Message Type - Media Embed | Push Chat | Push Documentation](#message-type-media-embed-push-chat-push-documentation)
- [Message Type - Reaction | Push Chat | Push Documentation](#message-type-reaction-push-chat-push-documentation)
---
# Introduction | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Intro to Push Chat
==================
Push Chat is a web3 messaging protocol that allows wallet addresses to send and receive messages without the need for traditional personal identifiers like phone numbers, email addresses, etc. It offers an enhanced layer of security and privacy compared to conventional messaging apps and allows for experiences that can only be achieved by native web3 messaging including the ability to **create token gated experiences, chat anonymously, tie your communication to your keys** and more!
Why Push Chat?[](#why-push-chat "Direct link to Why Push Chat?")
------------------------------------------------------------------
Push Chat protocol enables seamless experience in messaging among web3 wallets. It's secure, encrypted, stored on IPFS and enables a shared (interoperable) chat experience. It allows Wallet addresses (or other form of identities like NFTs) which are akin to web3 usernames to finally have communication capabilities. It also opens up some of the native Web3 experiences not possible before, such as —
* **Sending dms** with different message types like **GIFs**, **Embeds**, **Payments**, etc
* **Enabling web3 native chat on your frontend** without the user going to any other platform
* **Creating groups** for communities
* **Conditional/Gated access** for joining of the group or sending message
* **Enabling re-engagement** via [push notifications](/docs/notifications/)
protocol and providing Web2 UI (Like Whatsapp or Telegram)
* **Cross-chain compatibility** including EVMs, non-EVMS, Wallet addresses, NFT profiles, etc
* **Video / Audio calls** in either dm or in group
How Push Chat works?[](#how-push-chat-works "Direct link to How Push Chat works?")
------------------------------------------------------------------------------------
All communication from Push Chat is signed and validated by a set of nodes, which are together called Push Network. Read [understanding Push Chat in detail](/docs/chat/concepts/push-chat-architecture "Concept article exploring Push chat architecture")
for a detailed explanation of its architecture, spam control, decentralization efforts and more!
SDKs[](#sdks "Direct link to SDKs")
-------------------------------------
Javascript
React
React Native
Dart
Kotlin
Swift
Message Types[](#message-types "Direct link to Message Types")
----------------------------------------------------------------
TextImageFileMedia EmbedReaction
Messaging with Push[](#messaging-with-push "Direct link to Messaging with Push")
----------------------------------------------------------------------------------
Best way to understand Push Chat is to interact with it directly. To get started —
1. Head to [https://app.push.org/chat/pushai.eth](https://app.push.org/chat/pushai.eth)
2. Login with your wallet, ENS, UD or NFT. Push supports **multiple identities** including —
* Wallet Addresses — [0x99A08ac6254dcf7ccc37CeC662aeba8eFA666666](https://app.push.org/chat/0x99A08ac6254dcf7ccc37CeC662aeba8eFA666666)
* [ENS Domains](https://ens.domains)
— Like vitalik.eth or [harshr.eth](https://app.push.org/chat/harshr.eth)
* [UD Domains](https://unstoppabledomains.com/)
— Like sandeep.polygon or [harsh.crypto](https://app.push.org/chat/harsh.crypto)
* Lens or any NFT Handle — Like stani.lens or any NFT handle. \*\* NFT Chat supported on SDK but not on [app.push.org](https://app.push.org)
\*\*
3. Start chatting.
4. Alternatively, you can also use any of the list of growing partners to experience chat on —
Unstoppable Domains
Orb
Soclly
Graviton
Nata
Push
**Integrated Push Chat on mainnet?** [Write to us](mailto:support@push.org)
to get included in the list
Partners[](#partners "Direct link to Partners")
-------------------------------------------------
As a grassroot project, Push believes that combined, collaborative effort will lead to innovations and will keep pushing the boundaries of Web3. We work with these partners constantly to try out new features, ease development efforts of developers and develop new standards and features!
Polygon DSK
Unstoppable Domains
* [Why Push Chat?](#why-push-chat)
* [How Push Chat works?](#how-push-chat-works)
* [SDKs](#sdks)
* [Message Types](#message-types)
* [Messaging with Push](#messaging-with-push)
* [Partners](#partners)
---
# Message Type - Text | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - Text
===================
Enables sending simple text messages to the recipient.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'Text', content: 'Hello Bob!',});
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `Text` | `Text` | Type of message content |
| \- | _`message.content`_ | `string` | \- | Pass plain text in the message content |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---
# Intro to Message Types | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
Intro to Message Types
======================
Each message of Push Chat is a json payload that carries with it a message type and some parameters that enable each frontend that integrates Push Chat to understand and display various message types.
Push Chat supports an evergrowing list message types, all of which can be sent by `chat.send`, though some require passing few additional parameters.
[Text\
----\
\
Enables sending simple text messages to the recipient.](/docs/chat/message-types/text/)
[Image\
-----\
\
Enables sending a single image as a messages to the recipient. You will need to pass the image as base64. Base64 is a method for encoding binary data into ASCII text.](/docs/chat/message-types/image/)
[File\
----\
\
Enables sending single file or attachement as a message. You will need to pass the file as base64. Base64 is a method for encoding binary data into ASCII text.](/docs/chat/message-types/file/)
[Media Embed\
-----------\
\
Enables sending a image URLs or media URLs as a message. You can send GIFs, Tweets, Youtube links, etc. Simply pass in the URL of the media as content.](/docs/chat/message-types/media-embed/)
[Reaction\
--------\
\
Enables reacting by using emoji to a message.](/docs/chat/message-types/reaction/)
[Meta\
----\
\
Enables sending arbitary meta actions in a group. This message type has some rules and it's recommeneded to not interact directly with this message type as Push SDK will handle it for you. It's documentated just for the curious minds.](/docs/chat/message-types/meta/)
---
# Message Type - File | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - File
===================
Enables sending single file or attachement as a message. You will need to pass the file as base64. [Base64](https://en.wikipedia.org/wiki/Base64)
is a method for encoding binary data into ASCII text.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'File', content: '{"content":"data:application/pdf;base64,JVBERi0xLjQKJ}',});
_`Important`_ - Files less than 1 MB are currently supported.
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `File` | `Text` | Type of message Content |
| \- | _`message.content`_ | `string` | \- | Message Content |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---
# Message Type - Image | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - Image
====================
Enables sending a single image as a messages to the recipient. You will need to pass the image as base64. [Base64](https://en.wikipedia.org/wiki/Base64)
is a method for encoding binary data into ASCII text.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'Image', content: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAvklEQVR4AcXBsW2FMBiF0Y8r3GQb6jeBxRauYRpo4yGQkMd4gg==',});
Push Chat also supports Image URLs (including GIFs), see [Media Embed](/docs/chat/message-types/media-embed/)
message type to learn more.
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `Image` | `Text` | Type of message Content |
| \- | _`message.content`_ | `string` | \- | Message Content |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---
# Message Type - Meta | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - Meta
===================
Enables sending arbitary meta actions in a group. This message type has some rules and it's recommeneded to not interact directly with this message type as Push SDK will handle it for you. It's documentated just for the curious minds.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'Meta', content: "Alice.eth create the grp 'xyz'", // content can be eliminated info: { // any added info that is not visible but can be programmatically understood affected: [], // recipients // this can be array arbitary: { // optional, can have anything, never shown based on type timestamp: // epoch one, include timestamp so session key becomes different } }});
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `Meta` | `Text` | Type of message Content |
| \- | _`message.content`_ | `CREATE_GROUP` or `ADD_MEMBER` or `REMOVE_MEMBER` or `ASSIGN_MEMBER_PRIVILEGE` or `UPDATE_GROUP` or `UPDATE_GROUP_PROFILE` or `UPDATE_GROUP_META` or `USER_INTERACTION` or `CREATE_SPACE` or `ADD_LISTENER` or `REMOVE_LISTENER` or `ASSIGN_LISTENER_PRIVILEGE` or `ASSIGN_SPEAKER_PRIVILEGE` or `ASSIGN_COHOST_PRIVILEGE` | \- | Message Content |
| \- | _`options.info`_ | `{ affected : string[]: arbitrary?: { [key: string]: any } }` | \- | Pass recipients in the affected array list, any arbitary data if applicable can be passed in arbitary object |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---
# Message Type - Media Embed | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - Media embed
==========================
Enables sending a image URLs or media URLs as a message. You can send GIFs, Tweets, Youtube links, etc. Simply pass in the URL of the media as content.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'MediaEmbed', content: 'https://media1.giphy.com/media/FtlUfrq3pVZXVNjoxf/giphy360p.mp4?cid=ecf05e47jk317254v9hbdjrknemduocie4pf54wtsir98xsx&ep=v1_videos_search&rid=giphy360p.mp4&ct=v',});
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `MediaEmbed` | `Text` | Type of message Content |
| \- | _`message.content`_ | `string` | \- | Message Content |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---
# Message Type - Reaction | Push Chat | Push Documentation
[Skip to main content](#__docusaurus_skipToContent_fallback)
On this page
Message type - Reaction
=======================
Enables reacting by using emoji to a message.
* js
// userAlice.chat.send(recipient, message)// This section focuses on customization parameters for 'message' objectconst aliceMessagesBob = await userAlice.chat.send(recipient, { type: 'Reaction', content: '👍', // content can be eliminated reference: 'bafyreia2okco5ocdxmoxon72erviypaht74u3dqunf3vydu237ybju4kw4', // pass in the reference to the message hash that this reaction is intended for});
* * *
### Customization parameters[](#customization-parameters "Direct link to Customization parameters")
When sending a message, you can customize the following params
| Param | Type | Subtype | Default | Remarks |
| --- | --- | --- | --- | --- |
| _`recipient`_ | `string` | \- | \- | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ "Supported wallet standards for Push Chat")
including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | \- | \- | Configuration for message to be sent |
| \- | _`message.type`_ | `Meta` | `Text` | Type of message Content |
| \- | _`message.content`_ | `string` | \- | Emoji Symbol - 👍, 👎, ❤️, 👏, 😄, 😢 |
| \- | _`options.reference`_ | `string` | \- | Pass in the reference to the message hash that this reaction is intended for |
> Note: Parameters _`in this style`_ are mandatory.
* [Customization parameters](#customization-parameters)
---