Create add-on/plugin

curl --request POST \
  --url https://apiweb.mile.app/api/v3/plugin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=<string>' \
  --form 'description=<string>' \
  --form resourceFile='@example-file' \
  --form icon='@example-file'

{
  "status": true,
  "message": "Plugin created successfully",
  "data": {
    "id": "68b440c9dad4c5d45707f6d2",
    "name": "Custom Dashboard Widget",
    "description": "A custom widget for displaying real-time analytics data",
    "resourceFile": "1756656087_Custom-Dashboard-Widget.js",
    "icon": "https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg",
    "organizationId": "686cc0ff083ca8093204f002",
    "resourceUrl": "https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js",
    "createdBy": "user@mile.app",
    "updatedBy": "user@mile.app",
    "createdTime": "2025-08-31T10:30:00.000000Z",
    "updatedTime": "2025-08-31T10:35:00.000000Z",
    "organizationName": "MileApp",
    "isUsed": false,
    "customModuleId": null,
    "status": "active"
  }
}

POST

plugin

Create add-on/plugin

curl --request POST \
  --url https://apiweb.mile.app/api/v3/plugin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=<string>' \
  --form 'description=<string>' \
  --form resourceFile='@example-file' \
  --form icon='@example-file'

{
  "status": true,
  "message": "Plugin created successfully",
  "data": {
    "id": "68b440c9dad4c5d45707f6d2",
    "name": "Custom Dashboard Widget",
    "description": "A custom widget for displaying real-time analytics data",
    "resourceFile": "1756656087_Custom-Dashboard-Widget.js",
    "icon": "https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg",
    "organizationId": "686cc0ff083ca8093204f002",
    "resourceUrl": "https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js",
    "createdBy": "user@mile.app",
    "updatedBy": "user@mile.app",
    "createdTime": "2025-08-31T10:30:00.000000Z",
    "updatedTime": "2025-08-31T10:35:00.000000Z",
    "organizationName": "MileApp",
    "isUsed": false,
    "customModuleId": null,
    "status": "active"
  }
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Body

multipart/form-data

name

string

required

Name of the add-on/plugin (3-100 characters, must be unique within your organization)

Required string length: 3 - 100

description

string

required

resourceFile

file

required

JavaScript file (.js) containing the add-on code (max 5MB). Must contain valid JavaScript syntax.

icon

file

SVG icon file (.svg) for the add-on (max 500KB, optional)

Response

Plugin created successfully

status

boolean

required

Operation success status

Example:

true

message

string

required

Success message

Example:

"Plugin created successfully"

data

object

required

Show child attributes

data.id

string

required

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

data.name

string

required

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

data.description

string

required

data.resourceFile

string

required

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

data.organizationId

string

required

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

data.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

data.createdBy

string

required

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

data.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

data.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

data.organizationName

string

required

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

data.isUsed

boolean

required

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

data.icon

string | null

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

data.updatedBy

string | null

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

data.customModuleId

string | null

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

Example:

{
  "id": "68b440c9dad4c5d45707f6d2",
  "name": "Custom Dashboard Widget",
  "description": "A custom widget for displaying real-time analytics data",
  "resourceFile": "1756656087_Custom-Dashboard-Widget.js",
  "icon": "https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg",
  "organizationId": "686cc0ff083ca8093204f002",
  "resourceUrl": "https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js",
  "createdBy": "user@mile.app",
  "updatedBy": "user@mile.app",
  "createdTime": "2025-08-31T10:30:00.000000Z",
  "updatedTime": "2025-08-31T10:35:00.000000Z",
  "organizationName": "MileApp",
  "isUsed": false,
  "customModuleId": null,
  "status": "active"
}

Delete App Integration Get add-on details

⌘I

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects

Authorizations

Body

Response