Manifest

All Apps should define a manifest (godoc) as a JSON object. The fields of the manifest are described in the following table:

For example, a typical App manifest would look like the following:

{
	"app_id": "hello-world",
    "version":"v0.8.0",
	"display_name": "Hello, world!",
	"icon": "icon.png",
	"homepage_url": "https://github.com/mattermost/mattermost-plugin-apps",
	"requested_permissions": [
		"act_as_bot"
	],
	"requested_locations": [
		"/channel_header",
		"/command"
	],
	"on_install": {
        "path": "/install"
	},
	"http": {
		"root_url": "http://localhost:4000"
	}
}

Permissions 

Apps need to request permissions from the System Admin who is installing them. After an App is installed and available to end users, each user in Mattermost will need to “authenticate” with your App. Using the act_as_user permission, your App will be performing an API call on behalf of each authenticated user.

The following table lists the supported permissions (godoc) an app can request:

Locations 

Locations (godoc) are spaces in the UI where an App can add interactions. Locations in the App framework are supported on the mobile, desktop, and web app clients unless otherwise noted. This list of locations will grow over time as the App framework expands.

Deployment methods 

HTTP 

Provides configuration for accessing an app that is deployed externally of Mattermost and is accessible via HTTP.

Example:

{
	"http": {
		"root_url": "https://myurl.test/somepath",
		"use_jwt": true
	}
}

AWS Lambda 

Provides configuration for deploying an App onto the AWS Lambda and S3 services. All fields are mandatory ().

Each AWS Lambda function contains the following fields:

Example:

{
  	"aws_lambda": {
    	"functions": [
	  		{
	    		"path": "/",
	  	  		"name": "my-funct",
	  	  		"handler": "my-funct",
	  	  		"runtime": "go1.x"
 			}
		]
	}
}

OpenFaaS 

Provides configuration for deploying an App onto OpenFaaS and faasd platforms. All fields are mandatory ().

Each function contains the following fields:

Example:

{
  	"open_faas": {
    	"functions": [
	  		{
	    		"path": "/",
	  	  		"name": "my-funct"
  			}
		]
	}
}