Browse the docs

Connected apps

Connected apps in Allpage: its screens, what you can do there and its operations.

Availability. Every business has it.

What you can do

  • Connect an app: only you can do it, on its screen
  • Disconnect an app: only you can do it, on its screen
  • Re-approve a connected app: only you can do it, on its screen
  • Choose what a connected app can do: only you can do it, on its screen

For apps

Tools

  • apps_connect (Connect an app): only the owner can do it: the tool answers with a single-use link for them to open, signed in, and does nothing else

Reads

  • apps_list (Connected apps)
  • apps_summary (What’s going on)

Only the owner, in Allpage

  • Disconnect an app
  • Re-approve a connected app
  • Choose what a connected app can do

Operations

Each one's input and output, as JSON Schema. Ids are typed (typed ids).

apps.connect

Connect an app

Kind
Owner only
Tool
apps_connect
Scope
apps:write
Reached by
MCP

only the owner can do it: the tool answers with a single-use link for them to open, signed in, and does nothing else

Input
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
Output
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "const": "done"
        },
        "title": {
          "type": "string"
        },
        "change": {
          "type": "boolean"
        },
        "result": {
          "type": "object",
          "properties": {},
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "title",
        "change",
        "result"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "const": "refused"
        },
        "title": {
          "type": "string"
        },
        "change": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "field": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "title",
        "change",
        "message"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "const": "needs"
        },
        "kind": {
          "type": "string",
          "enum": [
            "module",
            "portal",
            "business",
            "limit",
            "paused",
            "reauth"
          ]
        },
        "title": {
          "type": "string"
        },
        "change": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "note": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "kind",
        "title",
        "change",
        "message"
      ],
      "additionalProperties": {}
    }
  ]
}