Skip to main content

Messaging

Every application has a built-in inbox for receiving messages and an outbox for sending messages. This allows users and applications to send data between each other knowing nothing than the other user’s DID and application name.

Learn more about the messaging architecture.

Open messaging

You can simply open the messaging capabilities for the currently connected application context as follows:

const messaging = await context.getMessaging()

Fetching messages (Inbox)

Get messages

You can retreive the 20 most recent messages:

const messages = await messaging.getMessages()

Alternatively, specify optional filter and options parameters:

const filter = {
type: 'inbox/dataRequest'
}
const options = {
limit: 20,
skip: 0,
sort: [{ sentAt: 'desc' }]
}
const messages = await messaging.getMessages(filter, options)

Listen for messages

Your application can register a callback function to listen for new inbox messages:

const listener = await messaging.onMessage(function(inboxEntry) {
console.log('New inbox message received', inboxEntry)
})

The inboxEntry object utilises the inbox/entry schema. The two most important properties are:

  • type — The type of inbox entry. This references a full schema URL.
  • data — The data contained in the inbox entry. This will be an object adhering to the schema specified in type. See a list of currently supported inbox types.

You can stop listening:

listener.cancel()

Sending messages (Outbox)

Your application can send messages to other accounts on the Verida network.

This example sends a contact record to a user’s Verida Vault:

const did = 'did:vda:0x6B2a1bE81ee770cbB4648801e343E135e8D2Aa6F'
const type = 'inbox/type/dataSend'

// Generate an inbox message containing an array of data
const data = {
data: [
{
firstName: 'Verida',
lastName: 'Example',
email: 'verida.example@example.com',
schema: 'https://common.schemas.verida.io/social/contact/v0.1.0/schema.json'
}
]
}
const message = 'Sending you a contact'
const config = {
recipientContextName: 'Verida: Vault'
}

messaging.send(did, type, data, message, config)

This could be used in two scenarios:

  • A user sending their own data from one application they control to another
  • A user sending data to another user within the same application

Opening your app

It can be helpful if the Vault opens your application in a web browser after the user accepts a message. You can enable this by providing an optional parameter to the config.

ie:

const config = {
recipientContextName: 'Verida: Vault',
openUrl: 'https://www.myapp.com/custom-page'
}

Setting avatar and name

When sending an inbox message, the sender avatar and name are automatically loaded from the public profile of the sending Verida Account. You will need to set these for your account so they can be loaded by applications across the network (including the Verida Vault).

You could add your Verida Account to the Verida Vault and use the mobile app to set a profile avatar and name. This will then be the default for every application used by the sending Verida Account. Alternatively, you could manually set the profile information for the application context sending the inbox message. See Account Profiles for more information on how to achieve this.

Built-in Message Types

See core schemas repository for details on each supported inbox message type.

  • dataSend — Send one or many pieces of data to a user
  • dataRequest — Request data from a user, supports optional filters and conditions around user’s selecting data
  • message — Send a generic message / notification to a user

Examples

Sending data

Data can be sent to an account (see Outbox example above)

Requesting data

Data can be requested from an account:

const did = 'did:vda:0x6B2a1bE81ee770cbB4648801e343E135e8D2Aa6F'
const type = 'inbox/type/dataRequest'

// Generate an inbox message containing an array of data
const data = {
requestSchema: 'https://common.schemas.verida.io/social/contact/v0.1.0/schema.json',
filter: {},
userSelect: true
}
const message = 'Please share your contact details'
const config = {
recipientContextName: 'Verida: Vault'
}

messaging.send(did, type, data, message, config)

Options:

  • filter: A JSON filter to apply to the search when locating suitable data to share
  • userSelect: Boolean value indicating if the user can select the data to be returned. If false all matching data will be returned.
  • userSelectLimit: Integer limiting how many records a user can select.