Interface AppInterface

Application entity interface

Mirrors macs-node-sdk/lib/app/models/app.js.

Example

const app: AppInterface = {
  id: 'app-123',
  name: 'slack-integration',
  type: 'INTEGRATION',
  org: 'org-456',
  short_description: 'Send messages and read channels via a Slack bot user.',
  external_app_url: 'https://slack.com',
  tags: ['chat', 'messaging'],
  active: true
};
interface AppInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    name: string;
    type: AppType;
    org?: string;
    user?: string;
    client?: string;
    short_description?: string;
    long_description?: string;
    readme?: string;
    image?: string;
    external_app_url?: string;
    external_api_urls?: { [key: string]: string };
    external_api_key?: string;
    external_headers?: { [key: string]: string };
    public?: boolean;
    featured?: boolean;
    active?: boolean;
    tags?: string[];
    keywords?: string[];
    connectors?: any;
    webhooks?: any;
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? name type org? user? client? short_description? long_description? readme? image? external_app_url? external_api_urls? external_api_key? external_headers? public? featured? active? tags? keywords? connectors? webhooks?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the application

name

name: string

Application name (required, unique)

type

type: AppType

App type (required)

Optionalorg

org?: string

Organization ID the app belongs to

Optionaluser

user?: string

User ID the app belongs to (if not org-scoped)

Optionalclient

client?: string

Client ID (for CLIENT-type apps). Set server-side after createClient().

Optionalshort_description

short_description?: string

Brief description of the application

Optionallong_description

long_description?: string

Detailed description of the application

Optionalreadme

readme?: string

Markdown README rendered on the app profile

Optionalimage

image?: string

URL to application's icon/image

Optionalexternal_app_url

external_app_url?: string

External application URL for integrations

Optionalexternal_api_urls

external_api_urls?: { [key: string]: string }

Named external URLs used by the integration (validated as URLs server-side)

Optionalexternal_api_key

external_api_key?: string

API key used when calling the external app (encrypted at rest)

Optionalexternal_headers

external_headers?: { [key: string]: string }

Custom headers forwarded on external API calls

Optionalpublic

public?: boolean

Public listing flag

Optionalfeatured

featured?: boolean

Featured listing flag

Optionalactive

active?: boolean

Whether the application is currently active

Optionaltags

tags?: string[]

Tags for categorizing the application

Optionalkeywords

keywords?: string[]

Keywords for search functionality

Optional Readonlyconnectors

connectors?: any

Optional Readonlywebhooks

webhooks?: any

Settings

Member Visibility

On This Page

Properties