Skip to main content
ā€‹
id
string
required

Unique plugin identifier (MongoDB ObjectId). Example: 68b440c9dad4c5d45707f6d2

ā€‹
name
string
required

Plugin display name (3-100 characters). Example: Custom Dashboard Widget

ā€‹
description
string
required
ā€‹
resourceFile
string
required

Original filename of the JavaScript resource. Example: 1756656087_Custom-Dashboard-Widget.js

ā€‹
organizationId
string
required

Organization identifier. 'system' for global plugins, organization ID for custom plugins. Example: 686cc0ff083ca8093204f002 or system

ā€‹
resourceUrl
string
required

Full URL where the JavaScript resource is hosted. Example: https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js

ā€‹
createdBy
string
required

Email address of the user who created the plugin. Example: user@mile.app

ā€‹
createdTime
string<date-time>
required

ISO 8601 timestamp when the plugin was created. Format: YYYY-MM-DDTHH:mm:ss.ffffffZ. Example: 2025-08-31T10:30:00.000000Z

ā€‹
updatedTime
string<date-time>
required

ISO 8601 timestamp when the plugin was last updated. Format: YYYY-MM-DDTHH:mm:ss.ffffffZ. Example: 2025-08-31T10:35:00.000000Z

ā€‹
organizationName
string
required

Organization display name. 'Global' for system plugins, actual organization name for custom plugins. Example: MileApp or Global

ā€‹
isUsed
boolean
required

Indicates if the plugin is currently active/installed in your organization. Example: false

ā€‹
icon
string | null

Full URL to the plugin icon (if available). Example: https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg

ā€‹
updatedBy
string | null

Email address of the user who last updated the plugin. May be null if never updated. Example: user@mile.app

ā€‹
customModuleId
string | null

ID of associated custom module or null if standalone. Example: null or 62846484ed5be87b6f4358f3