@envoy/envoy-integrations-sdk / EnvoyPluginAPI
API endpoints for plugin-scoped tokens.
-
EnvoyAPI↳ EnvoyPluginAPI
- createNotification
- getPluginInstallConfig
- setPluginInstallConfig
- storagePipeline
- updateJob
- loginAsPlugin
• new EnvoyPluginAPI(accessToken)
| Name | Type |
|---|---|
accessToken |
string |
EnvoyAPI.constructor
• Readonly axios: AxiosInstance
HTTP Client with Envoy's defaults.
EnvoyAPI.axios
▸ createNotification(installId, params?): Promise<void>
| Name | Type |
|---|---|
installId |
string |
params |
Object |
Promise<void>
▸ getPluginInstallConfig(installId): Promise<Record<string, unknown>>
Fetches the current config saved for this install during setup by the customer.
| Name | Type |
|---|---|
installId |
string |
Promise<Record<string, unknown>>
▸ setPluginInstallConfig(installId, config): Promise<void>
Merges changes with the current config saved for this install during setup by the customer.
To remove an item from the saved config, set the item's key to null.
| Name | Type |
|---|---|
installId |
string |
config |
Record<string, unknown> |
Promise<void>
▸ storagePipeline(commands, installId?): Promise<(null | EnvoyStorageItem<unknown>)[]>
| Name | Type |
|---|---|
commands |
EnvoyStorageCommand[] |
installId? |
string |
Promise<(null | EnvoyStorageItem<unknown>)[]>
▸ updateJob(jobId, update): Promise<void>
| Name | Type |
|---|---|
jobId |
string |
update |
default |
Promise<void>
▸ Static loginAsPlugin(id?, secret?): Promise<EnvoyMetaAuth>
Gets a plugin access token using client_credentials as the grant type.
| Name | Type |
|---|---|
id |
string |
secret |
string |
Promise<EnvoyMetaAuth>