Understanding the custo-manifest file structure

You can use this article to understand the JSON envelope of a Rainbow Extensions custo-manifest. You will see where extension points are declared, how actions are organized, and which root fields Rainbow expects.

JSON skeleton

{
  "version": "2",
  "jsonType": "Rainbow-custo-manifest",
  "extension-points": {
    "<EXTENSION-POINT-KEY>": [
      {
        "name": "...",
        "icon": "...",
        "command": {
          "url": "...",
          "params": "...",
          "commandType": "rest",
          "method": "GET"
        },
        "responseType": "markdown"
      }
    ]
  }
}

Global rules

• version must be "2".
• jsonType must be "Rainbow-custo-manifest". This is also how Rainbow identifies the manifest inside a ZIP archive.
• Each key under extension-points is an array.
• Each extension point supports up to 3 actions.
• Each action must contain a valid command object. name and icon are mandatory depending on the extension point.
• Variables can be used in supported fields such as command.url, command.params, REST body parameters and display content.

PBX event extension points

Button extension points

Display and frame extension points