Interface AppDefinition<Name, Credential, Actions, Triggers>
interface AppDefinition {
actions?: Actions;
auth: AnyAuthDefinition<Credential>;
description?: string;
http?: RequestHandler;
name: Name;
tags?: Tag[];
triggers?: Triggers;
}
actions?: Actions;
auth: AnyAuthDefinition<Credential>;
description?: string;
http?: RequestHandler;
name: Name;
tags?: Tag[];
triggers?: Triggers;
}
Type Parameters
Name extends string = string
Credential extends AnyAppCredential = AnyAppCredential
Actions extends Record<string, ActionDefinition<string, any, Credential>> | undefined = Record<string, ActionDefinition<string, any, Credential>> | undefined
Triggers extends Record<string, PollingTriggerDefinition<string, Credential, any, any, any> | PushTriggerDefinition<string, Credential, any, any> | WebhookTriggerDefinition<string, Credential, any, any, any, any>> | undefined = Record<string, PollingTriggerDefinition<string, Credential, any, any, any> | PushTriggerDefinition<string, Credential, any, any> | WebhookTriggerDefinition<string, Credential, any, any, any, any>> | undefined
Hierarchy
- AppDefinition
Properties
Optional actions
actions?: Actions
An object containing Actions for this Connector,
where keys correspond to actionKey
and values are action definitions returned from defineAction function.
See
auth
Authorization definition for this Connector, or false if no auth is required.
See
Optional description
description?: string
Optional http
HTTP handler for this Connector.
name
name: Name
Name of the App that will be displayed in UI
Optional tags
tags?: Tag[]
Optional triggers
triggers?: Triggers
An object containing Triggers for this Connector,
where keys correspond to triggerKey
and values are trigger definitions returned from defineWebhookTrigger,
definePollingTrigger, or definePushTrigger function.
Describes a Connector.