Interface AnyAppDefinition

Describes a Connector.

interface AnyAppDefinition {
    actions?: Record<string, AnyActionDefinition>;
    auth: AnyAuthDefinition<AnyAppCredential>;
    description?: string;
    http?: RequestHandler;
    name: string;
    tags?: Tag[];
    triggers?: Record<string, AnyTriggerDefinition>;
}

Hierarchy

Properties

actions? auth description? http? name tags? triggers?

Properties

Optional actions

actions?: Record<string, AnyActionDefinition>

An object containing Actions for this Connector, where keys correspond to actionKey and values are action definitions returned from defineAction function.

See

Actions

auth

auth: AnyAuthDefinition<AnyAppCredential>

Authorization definition for this Connector, or false if no auth is required.

See

Auth

Optional description

description?: string

Optional http

http?: RequestHandler

HTTP handler for this Connector.

See

Handling HTTP Requests

name

name: string

Name of the App that will be displayed in UI

Optional tags

tags?: Tag[]

Optional triggers

triggers?: Record<string, AnyTriggerDefinition>

An object containing Triggers for this Connector, where keys correspond to triggerKey and values are trigger definitions returned from defineWebhookTrigger, definePollingTrigger, or definePushTrigger function.

See

Triggers