ExtensionInstallations
Install an extension
Installs a published version with a scope, permissions, and a send mode, and returns it with status 201.
Installs a published version with a scope, permissions, and a send mode, and returns it with status 201. The installation acts on your grants narrowed to these; a webhook installation's API key and webhook secret are returned once. Only a person can install, not an API key.
Authorization
apiKey x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
extension*string
version?|null
mailboxIds?array<>|null
namespaceId?|null
permissions?array<>|null
sendMode?|null
webhookUrl?string|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/extension-installations" \ -H "Content-Type: application/json" \ -d '{ "extension": "string" }'{ "installation": { "id": "string", "extensionId": "string", "name": "string", "displayName": "string", "version": { "id": "string", "version": "string" }, "runtime": "hosted", "status": "active", "createdAt": "string", "events": [ "mailbox.message.received" ], "permissions": [ "read" ], "sendMode": "send", "scope": { "mailboxIds": [ "string" ], "namespaceId": "string" }, "webhook": { "endpointId": "string", "url": "string" }, "updatedAt": "string", "disabledAt": "string" }, "credentials": { "apiKey": "string", "webhookSecret": "string" }}