samva-dev · Schema

InstallExtensionResponse

CompanyEmailSoftware-as-a-ServiceDevelopers

Properties

Name Type Description
installation object
credentials object
View JSON Schema on GitHub

JSON Schema

samva-dev-install-extension-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/samva-dev/json-schema/samva-dev-install-extension-response-schema.json",
  "title": "InstallExtensionResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/samva-dev-extension-installations-api-openapi.yml#/components/schemas/InstallExtensionResponse",
  "type": "object",
  "properties": {
    "installation": {
      "$ref": "#/$defs/ExtensionInstallation"
    },
    "credentials": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "apiKey": {
              "type": "string",
              "x-sensitive": true
            },
            "webhookSecret": {
              "type": "string",
              "x-sensitive": true
            }
          },
          "required": [
            "apiKey",
            "webhookSecret"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "installation",
    "credentials"
  ],
  "additionalProperties": false,
  "$defs": {
    "ExtensionId": {
      "type": "string",
      "pattern": "^ext_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "ExtensionId"
    },
    "ExtensionInstallation": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/ExtensionInstallationId"
        },
        "extensionId": {
          "$ref": "#/$defs/ExtensionId"
        },
        "name": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "version": {
          "$ref": "#/$defs/ExtensionVersionRef"
        },
        "runtime": {
          "type": "string",
          "enum": [
            "hosted",
            "webhook"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "disabled"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "events": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "mailbox.message.received",
              "mailbox.message.sent",
              "mailbox.action.pending_approval",
              "mailbox.action.resolved",
              "mailbox.message.quarantined",
              "mailbox.message.released",
              "mailbox.message.discarded"
            ]
          }
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "read",
              "update",
              "send",
              "quarantine.read"
            ]
          }
        },
        "sendMode": {
          "type": "string",
          "enum": [
            "send",
            "approval"
          ]
        },
        "scope": {
          "type": "object",
          "properties": {
            "mailboxIds": {
              "anyOf": [
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/$defs/MailboxId"
                  }
                },
                {
                  "type": "null"
                }
              ]
            },
            "namespaceId": {
              "anyOf": [
                {
                  "$ref": "#/$defs/NamespaceId"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "mailboxIds",
            "namespaceId"
          ],
          "additionalProperties": false
        },
        "webhook": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "endpointId": {
                  "$ref": "#/$defs/WebhookEndpointId"
                },
                "url": {
                  "type": "string"
                }
              },
              "required": [
                "endpointId",
                "url"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "updatedAt": {
          "type": "string"
        },
        "disabledAt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "extensionId",
        "name",
        "displayName",
        "version",
        "runtime",
        "status",
        "createdAt",
        "events",
        "permissions",
        "sendMode",
        "scope",
        "webhook",
        "updatedAt",
        "disabledAt"
      ],
      "additionalProperties": false
    },
    "ExtensionInstallationId": {
      "type": "string",
      "pattern": "^exti_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "ExtensionInstallationId"
    },
    "ExtensionVersionId": {
      "type": "string",
      "pattern": "^extver_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "ExtensionVersionId"
    },
    "ExtensionVersionRef": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/ExtensionVersionId"
        },
        "version": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "version"
      ],
      "additionalProperties": false
    },
    "MailboxId": {
      "type": "string",
      "pattern": "^mbx_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "MailboxId"
    },
    "NamespaceId": {
      "type": "string",
      "pattern": "^ns_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "NamespaceId"
    },
    "WebhookEndpointId": {
      "type": "string",
      "pattern": "^wep_[0-9a-hjkmnp-tv-z]{16,24}$",
      "x-samva-brand": "WebhookEndpointId"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/samva-dev-install-extension-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.