Reference

The public key of your workspace. You need to go to your workspace settings to get this key.

The time, in milliseconds, for the Messenger to wait before pulling the latest changes from the server. This acts as a fallback in case the component's websocket doesn't work.

You can pass your user's information here or leave it blank for usage in guest mode. More information.

Options for customizing the Messenger's appearance and content. More information.

Your signed in User's information. Use your auth provider to get this information.

The time, in days, for how long a guest's information is kept in their local storage.

The unique identifier of the user. Use the one from your auth provider as it will used for future updates to their personal information. Internally, this id is indexed with the workspace ID, so there is no danger of conflicts in case this same user is used in multiple workspaces in Makkuro.

Your user's full name.

Your user's email address. It's ok if it changes, we always use the ID to identify the user.

Your user's avatar. If not provided, we'll just render a generic anonymous figure.

This will update the background color of the header and the color of the send button. Other types, such as rgba and hsl, are also supported.

Customization options for the header. Passing a React JSX Element will render your component instead and using null will hide the header completely. If nothing is provided (undefined), the default header will be shown.

Panels are the white boxes that contain content in the Messenger and you can completely customize them. If nothing is provided (undefined), just the panel with the conversations list will be shown. More information

The title that shows at the top of the Messenger. Usually contains a greeting.

The short text under this title where you can provide more information about your reply times, or time of operation. There is no limit to the length of this text.

Avatars that are shown on the right side of the header. These are usually the agents that are currently online and you would currently need to provide them statically.

The URL of the agent's avatar.

The name of the agent, used only for the alt text of the image.

You only need to provide this static property to render the conversations panel.

This static property will help Makkuro understand that a panel with links needs to be rendered.

The content of the links panel.

An optional title for the links panel.

The content of the links panel.

The URL of the link.

The text that will be shown as the link.

The target attribute of the link.

An optional icon that will be shown before the label.

This static property will help Makkuro understand that a panel with a card needs to be rendered.

The content of the card panel.

The image that will be shown on the top of the card.

The title of the card.

The description of the card.

An optional link that will be shown at the bottom of the card.

The URL of the image.

The alt text of the image.

This will update the notification sound. If a null value is provided, no sound will be played at all.

This will update the page title of the Messenger's window tab. If a null value is provided, the page title will not change.