Full documentation for interactive messages?

Trying to locate complete documentation for how to programmatically create/consume interactive messages.

Steps to reproduce
This docs page ‘Interactive Messages’ (Interactive messages) has some info on how to create and work with interactive messages.

That examples on that page make it clear that there exist actions of type ‘button’ and ‘select’.

However, that page doesn’t seem to provide a complete list of all the available action types, nor the different options/properties those action types can accept.

Where are these attachment and action types are fully documented?

On the ‘Interactive messages’ page, the section ‘Message buttons’ points to the documentation page ‘Use message attachments’ (Message attachments). That page has no information about the available action types, and redirects people looking for more information back to the ‘Interactive Messages’ page.

On the developer API Reference, I can’t find anything in the ‘POSTS’ section on creating interactive messages, and can’t see any other sections where such information would be.

Searching the API Reference for ‘interactive messages’ brings up results all of which are about ‘Interactive Dialogs’.

Is there any more documentation, other than the two pages mentioned above?

(What I’m trying to determine, among other things, is (a) whether the response to an interactive message button can add to the existing message, rather than simply overwriting what is there; (b) is there an multiselect action type as there is in Slack’s interactive messages?)

Very many thanks

Hi James,

Thanks for reaching out, and welcome to the Mattermost community forums!

I apologize for the confusion around the docs as well. The Mattermost documentation does not currently provide a comprehensive list of all available action types for interactive messages, nor the different options/properties they can accept. However, I can still provide you with some information that might be helpful.

Regarding your questions:

a) Yes, the response to an interactive message button can add to the existing message rather than overwriting it. You can use the update API call to update the original message with the new content you want to add.

b) As of now, Mattermost does not have a built-in action type for multiselect in interactive messages. However, you can achieve similar functionality by using the select action type and allowing users to select multiple options by holding down the Ctrl (or Command) key while making their selections.

While the interactive message documentation is limited, you can find some examples and additional guidance in the Mattermost GitHub repository’s sample apps. These sample apps showcase different use cases and can provide insights into how to create and consume interactive messages programmatically.

I apologize for any inconvenience caused by the lack of comprehensive documentation on this topic. If you have any further questions or need assistance with any specific use case, please let me know, and I’ll do my best to help you!

Best regards,
~Matterbot 2.0 :robot:

[Disclaimer: This is a beta AI assisted response powered by ChatGPT. Were any of the above suggestions inaccurate? Let us know by replying to this comment!]

It’s a shame there is no complete documentation; kind of hampers development and (presumably) adoption of MM.

Thanks for your reply, though.

1 Like