Skip to content
Build with XMTP
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Get started
SDK guide
Content types
Agents
Protocol
Specs
Reference
Menu
Get started
Build a quickstart chat app
Install the XMTP SDK
Run the backend
Push configuration
Migrate to a self-hosted backend
Deploy
Deployment overview
Deploy on Fly.io
Deploy on Railway
AWS ECS (Fargate)
Deploy on Kubernetes
SDK guide
Client
Signer
Inboxes
Conversations and group chats
Send messages
Read conversations and messages
Stream messages
Sync
Backups
Groups
Consent
Disappearing messages
Delete messages
Push notifications
Debug
Use signatures
Extend the identity model
Content types
Understand content types with XMTP
Support attachments in your app built with XMTP
Reactions
Replies
Read receipts
Actions and intents
Wallet transactions
Transaction references
Stream group updates with XMTP
Markdown
Agents
Build an agent
Agent events
Agent middleware
Agent filters
Agent context
Deploy an agent
Tools
XMTP CLI
XMTP web chat
Protocol
MLS protocol overview
Messaging security
Envelope types
Topics
Epochs with XMTP
Intents with XMTP
Cursors
Identity model
Specs
Reference
Rate limits and capacity
XMTP error code glossary
Node SDK
Enumerations
ActionStyle
BackupElementSelectionOption
ConsentEntityType
ConsentState
ContentType
ConversationType
DeliveryStatus
GroupMembershipState
GroupMessageKind
GroupPermissionsOptions
IdentifierKind
ListConversationsOrderBy
LogLevel
MessageSortBy
MetadataField
PermissionLevel
PermissionPolicy
PermissionUpdateType
ReactionAction
ReactionSchema
SortDirection
WorkerKind
Classes
AccountAlreadyAssociatedError
AuthRequiredError
BackendMismatchError
ChainNotAcceptedError
Client
ClientNotInitializedError
ClientVersionTooOldError
CodecRegistry
ConfigurationInvalidError
ConfigurationUnavailableError
Conversation
Conversations
DebugInformation
DecodedMessage
Dm
Group
InboxReassignError
MessageStream
MissingContentTypeError
NotificationError
Preferences
ServerConfigurationError
SignerUnavailableError
StreamFailedError
StreamInvalidRetryAttemptsError
Interfaces
Action
Actions
ApiStats
AppDataChange
ArchiveMetadata
ArchiveOptions
AsyncStreamProxy
Attachment
AuthConfiguration
Backend
BackendBuilder
Consent
ConversationDebugInfo
ConversationListItem
CreateDmOptions
CreateGroupOptions
Cursor
DeliveryCursor
EncryptedAttachment
GroupMember
GroupMetadata
GroupPermissions
GroupSyncSummary
GroupUpdated
HmacKey
Identifier
IdentityStats
Inbox
InboxState
Installation
Intent
KeyPackageStatus
LeaveRequest
Lifetime
LimitsConfiguration
ListConversationsOptions
ListMessagesOptions
LogOptions
Message
MessageCatchUp
MessageCatchUpGeneration
MessageDisappearingSettings
MessageHistorySnapshot
MessageTopicStatus
MetadataFieldChange
MlsConfiguration
MultiRemoteAttachment
PermissionPolicySet
Reaction
ReadReceipt
RemoteAttachment
Reply
RetentionConfiguration
SendMessageOpts
SendOpts
ServerConfiguration
SignatureRequestHandle
SigningKeyDescription
TransactionMetadata
TransactionReference
VisibilityConfirmationOptions
WalletCall
WalletSendCalls
WorkerConfigOptions
WorkerIntervalOverride
WorkerJitterOverride
Type Aliases
BuiltInContentTypes
ClientOptions
ContentOptions
DeviceSyncOptions
DistributiveOmit
EnrichedReply
EOASigner
ExtractCodecContentTypes
GetBlockNumber
GetChainId
GetIdentifier
HexString
MessageAcknowledgement
MessageDelivery
MessageReaderSource
NetworkOptions
NotificationChannel
NotificationConfig
NotificationOverride
NotificationState
OtherOptions
ResolveValue
SCWSigner
Signer
SignMessage
StorageOptions
StreamBarrierFailure
StreamCallback
StreamFailureCause
StreamFailureDetails
StreamFunction
StreamOptions
StreamValueMutator
UnfinishedStreamTopic
UserPreferenceUpdate
Variables
DEFAULT_RETRY_ATTEMPTS
DEFAULT_RETRY_DELAY
Functions
contentTypeActions
contentTypeAttachment
contentTypeGroupUpdated
contentTypeIntent
contentTypeLeaveRequest
contentTypeMarkdown
contentTypeMultiRemoteAttachment
contentTypeReaction
contentTypeReadReceipt
contentTypeRemoteAttachment
contentTypeReply
contentTypeText
contentTypeTransactionReference
contentTypeWalletSendCalls
createBackend
createStream
decryptAttachment
encodeActions
encodeAttachment
encodeIntent
encodeMarkdown
encodeMultiRemoteAttachment
encodeReaction
encodeReadReceipt
encodeRemoteAttachment
encodeText
encodeTransactionReference
encodeWalletSendCalls
encryptAttachment
flushTelemetry
generateInboxId
getInboxIdForIdentifier
getStreamFailureDetails
initLogging
isActions
isAttachment
isGroupUpdated
isHexString
isIntent
isLeaveRequest
isMarkdown
isMultiRemoteAttachment
isReaction
isReadReceipt
isRemoteAttachment
isReply
isText
isTextReply
isTransactionReference
isWalletSendCalls
throwServerConfigurationError
toServerConfigurationError
validHex
Browser SDK
Enumerations
ActionStyle
BackupElementSelectionOption
ConsentEntityType
ConsentState
ContentType
ConversationType
DeliveryStatus
GroupMembershipState
GroupMessageKind
GroupPermissionsOptions
IdentifierKind
ListConversationsOrderBy
LogLevel
MessageSortBy
MetadataField
PermissionLevel
PermissionPolicy
PermissionUpdateType
ReactionAction
ReactionSchema
SortDirection
WorkerKind
Classes
AccountAlreadyAssociatedError
AuthRequiredError
BackendMismatchError
ChainNotAcceptedError
Client
ClientNotInitializedError
ClientVersionTooOldError
CodecRegistry
ConfigurationInvalidError
ConfigurationUnavailableError
Conversation
Conversations
DebugInformation
DecodedMessage
Dm
Group
GroupNotFoundError
InboxReassignError
MessageStream
Opfs
OpfsInitializationError
OpfsNotInitializedError
Preferences
ServerConfigurationError
SignerUnavailableError
StreamFailedError
StreamInvalidRetryAttemptsError
StreamNotFoundError
Interfaces
Action
Actions
ApiStats
ArchiveMetadata
ArchiveOptions
AsyncStreamProxy
Attachment
AuthConfiguration
Backend
BackendBuilder
Consent
ConversationDebugInfo
ConversationListItem
CreateDmOptions
CreateGroupOptions
Cursor
DeliveryCursor
EncryptedAttachment
GroupMember
GroupMetadata
GroupPermissions
GroupSyncSummary
GroupUpdated
HmacKey
Identifier
IdentityStats
Inbox
InboxState
Installation
Intent
KeyPackageStatus
LeaveRequest
Lifetime
LimitsConfiguration
ListConversationsOptions
ListMessagesOptions
LogOptions
Message
MessageCatchUp
MessageCatchUpGeneration
MessageDisappearingSettings
MessageHistorySnapshot
MessageTopicStatus
MetadataFieldChange
MlsConfiguration
MultiRemoteAttachment
PermissionPolicySet
Reaction
RemoteAttachment
Reply
RetentionConfiguration
SendMessageOpts
SendOpts
ServerConfiguration
SignatureRequestHandle
SigningKeyDescription
TransactionMetadata
TransactionReference
WalletCall
WalletSendCalls
WorkerConfigOptions
WorkerIntervalOverride
Type Aliases
BuiltInContentTypes
ClientOptions
ContentOptions
DeviceSyncOptions
DistributiveOmit
EnrichedReply
EOASigner
ExtractCodecContentTypes
GetBlockNumber
GetChainId
GetIdentifier
HmacKeys
LastReadTimes
MessageAcknowledgement
MessageDelivery
MessageReaderSource
NetworkOptions
OtherOptions
ReadReceipt
ResolveValue
SafeConversation
SafeSigner
SCWSigner
Signer
SignMessage
StorageOptions
StreamBarrierFailure
StreamCallback
StreamFailureCause
StreamFailureDetails
StreamFunction
StreamOptions
StreamValueMutator
UnfinishedStreamTopic
UserPreferenceUpdate
VisibilityConfirmationOptions
Variables
contentTypeActions
contentTypeAttachment
contentTypeGroupUpdated
contentTypeIntent
contentTypeLeaveRequest
contentTypeMarkdown
contentTypeMultiRemoteAttachment
contentTypeReaction
contentTypeReadReceipt
contentTypeRemoteAttachment
contentTypeReply
contentTypeText
contentTypeTransactionReference
contentTypeWalletSendCalls
decryptAttachment
DEFAULT_RETRY_ATTEMPTS
DEFAULT_RETRY_DELAY
encodeActions
encodeAttachment
encodeIntent
encodeMarkdown
encodeMultiRemoteAttachment
encodeReaction
encodeReadReceipt
encodeRemoteAttachment
encodeText
encodeTransactionReference
encodeWalletSendCalls
encryptAttachment
Functions
createBackend
createEOASigner
createSCWSigner
createStream
fetchServerConfiguration
generateInboxId
getErrorCode
getInboxIdForIdentifier
getStreamFailureDetails
isActions
isAttachment
isGroupUpdated
isIntent
isLeaveRequest
isMarkdown
isMultiRemoteAttachment
isReaction
isReadReceipt
isRemoteAttachment
isReply
isText
isTextReply
isTransactionReference
isWalletSendCalls
metadataFieldName
toSafeConversation
toSafeSigner
toServerConfigurationError
Agent SDK
Enumerations
ActionStyle
BackupElementSelectionOption
ConsentEntityType
ConsentState
ContentType
ConversationType
DeliveryStatus
GroupMembershipState
GroupMessageKind
GroupPermissionsOptions
IdentifierKind
ListConversationsOrderBy
LogLevel
MessageSortBy
MetadataField
PermissionLevel
PermissionPolicy
PermissionUpdateType
ReactionAction
ReactionSchema
SortDirection
WorkerKind
Classes
AccountAlreadyAssociatedError
ActionWizard
Agent
AgentError
AgentStreamingError
AuthRequiredError
Backend
BackendBuilder
BackendMismatchError
ChainNotAcceptedError
Client
ClientContext
ClientNotInitializedError
ClientVersionTooOldError
CodecRegistry
CommandRouter
ConfigurationInvalidError
ConfigurationUnavailableError
Conversation
ConversationContext
ConversationListItem
Conversations
DebugInformation
DecodedMessage
Dm
Group
GroupMember
GroupMetadata
GroupPermissions
InboxReassignError
MessageContext
MessageStream
MissingContentTypeError
NotificationError
PerformanceMonitor
Preferences
ServerConfigurationError
SignatureRequestHandle
SignerUnavailableError
StreamFailedError
StreamInvalidRetryAttemptsError
Interfaces
Action
Actions
ApiStats
AppDataChange
ArchiveMetadata
ArchiveOptions
AsyncStreamProxy
Attachment
AuthConfiguration
CommandRouterConfig
Consent
ConversationDebugInfo
CreateDmOptions
CreateGroupOptions
Cursor
DeliveryCursor
EncryptedAttachment
GroupSyncSummary
GroupUpdated
HealthReport
HmacKey
Identifier
IdentityStats
Inbox
InboxState
Installation
Intent
KeyPackageStatus
LeaveRequest
Lifetime
LimitsConfiguration
ListConversationsOptions
ListMessagesOptions
LogOptions
Message
MessageCatchUp
MessageCatchUpGeneration
MessageDisappearingSettings
MessageHistorySnapshot
MessageTopicStatus
MetadataFieldChange
MlsConfiguration
MultiRemoteAttachment
PerformanceMonitorConfig
PermissionPolicySet
Reaction
ReadReceipt
RemoteAttachment
Reply
RetentionConfiguration
SendMessageOpts
SendOpts
ServerConfiguration
SigningKeyDescription
TransactionMetadata
TransactionReference
VisibilityConfirmationOptions
WalletCall
WalletSendCalls
WorkerConfigOptions
WorkerIntervalOverride
WorkerJitterOverride
Type Aliases
ActionWizardCancelHandler
ActionWizardCancelOptions
ActionWizardCompleteHandler
ActionWizardOptions
AgentBaseContext
AgentCreateOptions
AgentErrorContext
AgentErrorMiddleware
AgentErrorRegistrar
AgentMessageHandler
AgentMiddleware
AgentOptions
AgentStreamingOptions
AttachmentUploadCallback
BuiltInContentTypes
ClientOptions
ContentOptions
CreateERC20TransferCallsOptions
CreateNativeTransferCallsOptions
DecodedMessageWithContent
DeviceSyncOptions
DistributiveOmit
EnrichedReply
EOASigner
EventHandlerMap
ExtractCodecContentTypes
GetBlockNumber
GetChainId
GetERC20BalanceOptions
GetERC20DecimalsOptions
GetIdentifier
HexString
InstallationInfo
MessageAcknowledgement
MessageContextParams
MessageDelivery
MessageReaderSource
NetworkOptions
NotificationChannel
NotificationConfig
NotificationOverride
NotificationState
OtherOptions
ResolveValue
SCWSigner
Signer
SignMessage
StorageOptions
StreamAllMessagesOptions
StreamBarrierFailure
StreamCallback
StreamFailureCause
StreamFailureDetails
StreamFunction
StreamOptions
StreamValueMutator
UnfinishedStreamTopic
User
UserPreferenceUpdate
Variables
createBackend
createStream
DEFAULT_RETRY_ATTEMPTS
DEFAULT_RETRY_DELAY
erc20Abi
f
filter
generateInboxId
getInboxIdForIdentifier
getStreamFailureDetails
isActions
isAttachment
isGroupUpdated
isIntent
isLeaveRequest
isMarkdown
isMultiRemoteAttachment
isReaction
isReadReceipt
isRemoteAttachment
isReply
isText
isTextReply
isTransactionReference
isWalletSendCalls
throwServerConfigurationError
toServerConfigurationError
Functions
contentTypeActions
contentTypeAttachment
contentTypeGroupUpdated
contentTypeIntent
contentTypeLeaveRequest
contentTypeMarkdown
contentTypeMultiRemoteAttachment
contentTypeReaction
contentTypeReadReceipt
contentTypeRemoteAttachment
contentTypeReply
contentTypeText
contentTypeTransactionReference
contentTypeWalletSendCalls
createERC20TransferCalls
createIdentifier
createNameResolver
createNativeTransferCalls
createRemoteAttachment
createRemoteAttachmentFromFile
createSigner
createUser
decryptAttachment
downloadRemoteAttachment
encodeActions
encodeAttachment
encodeIntent
encodeMarkdown
encodeMultiRemoteAttachment
encodeReaction
encodeReadReceipt
encodeRemoteAttachment
encodeText
encodeTransactionReference
encodeWalletSendCalls
encryptAttachment
flushTelemetry
getERC20Balance
getERC20Decimals
getInstallationInfo
getTestUrl
getValidLogLevels
initLogging
isHexString
logDetails
parseLogLevel
validHex
Swift SDK
Kotlin SDK
Rust
GitHub
Select theme
Dark
Light
Auto
ReadReceipt
Defined in: bindings/node/dist/index.d.ts:1273
