Documentation
@rollout/frameworkActionDefinitionAnyActionDefinitionAnyAppCredentialAnyAppDefinitionAnyAuthDefinitionAnyPollingTriggerDefinitionAnyPushTriggerDefinitionAnyTriggerDefinitionAnyTriggerPayloadSchemaFnAnyTriggerPayloadSchemaShapeAnyWebhookTriggerDefinitionAnyWebhookTriggerHandleEventFnApiTokenAuthDefinitionInputAppCredentialAppDefinitionAutomationAutomationOutputAutomationRunAutomationRunExecutionAutomationRunExecutionOutputConsumerExecuteActionFunctionExecutionLockedErrorGetAutomationGetAutomationOptsGetAutomationRunGetAutomationRunOptsGetAutomationRunWhereGetAutomationRunsGetAutomationRunsOptsGetAutomationRunsWhereGetAutomationWhereGetAutomationsGetAutomationsOptsGetAutomationsWhereGetCredentialOptionResultGetCredentialOptsGetLiveAutomationsGetLiveAutomationsOptsGetLiveAutomationsWhereGetPublicRolloutServiceUrlGetTriggerPayloadSchemaOptsHandleConsumerRequestOptsHandlePushTriggerEventHandlePushTriggerEventOptsHandleWebhookRequestJobOptsInferActionInputParamsSchemaInferOAuthEnvSchemaInferTriggerInputParamsSchemaInferTriggerPayloadSchemaJWTAuthDefinitionInputKeyValueStoreOAuthScopeErrorOnAutomationCreatedFunctionOnAutomationDeletedFunctionOnAutomationRunResultsCtxOnAutomationRunResultsFunctionOnAutomationUpdatedFunctionPollingTriggerDefinitionPushTriggerDefinitionRateLimitConfigRequestHandlerRolloutConfigTriggerEventUpdateAutomationTriggerSubscriptionDataUpdateAutomationTriggerSubscriptionDataOptsUpdateAutomationTriggerSubscriptionDataWhereUpsertCredentialOptsUserErrorWebhookTriggerDefinitionWithRateLimitingdefineActiondefineActionInputParamsSchemadefineApiTokenAuthdefineAppdefineHTTPHandlerdefineJWTAuthdefineOAuth1defineOAuth2defineOAuthEnvSchemadefinePollingTriggerdefinePushTriggerdefineTriggerInputParamsSchemadefineTriggerPayloadSchemadefineWebhookTriggergetAutomationgetAutomationRungetAutomationRunsgetAutomationsgetCredentialgetLiveAutomationsgetPublicRolloutServiceUrlgetTriggerPayloadSchemahandleConsumerRequesthandlePushTriggerEventhandleWebhookRequestJobkeyValueStoresetupRolloutupdateAutomationTriggerSubscriptionDataupsertCredentialwithRateLimiting
@rollout/framework/uiActionCardActionCardBooleanInputBooleanInputDropdownInputDropdownInputFileBrowserInputFileBrowserInputFindByFindByKeyValuesKeyValuesMultiSelectInputMultiSelectInputRichTextInputRichTextInputSpinnerSpinnerUIComponentPropsdefineUIComponentuseApiBaseUrluseConsumerTokenuseCredentialKeyuseHostAppContext
  • @rollout/framework
  • index
  • defineApp

Function defineApp

  • defineApp<Name, Credential, Actions, Triggers>(definition): AppDefinition<Name, Credential, Actions, Triggers>
  • Used to define a Connector.

    Type Parameters

    • Name extends string = string

    • Credential extends AnyAppCredential = AnyAppCredential

    • Actions extends undefined | Record<string, ActionDefinition<string, any, Credential>> = undefined | Record<string, ActionDefinition<string, any, Credential>>

    • Triggers extends undefined | 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>>

    Parameters

    • definition: AppDefinition<Name, Credential, Actions, Triggers>

    Returns AppDefinition<Name, Credential, Actions, Triggers>

    See

    Defining Connectors

    Example

    import { defineApp } from "@rollout/framework";
    import { auth } from "./auth";
    import { http } from "./http";
    import { triggers } from "./triggers";
    import { actions } from "./actions";

    export const app = defineApp({
    name: "My App",
    auth,
    http,
    triggers,
    actions,
    });