This documentation covers Rollout v2. For Rollout v1 docs, see
docs.rollouthq.com
.
Search
Documentation
@rollout/framework
ActionDefinition
AnyActionDefinition
AnyAppCredential
AnyAppDefinition
AnyAuthDefinition
AnyPollingTriggerDefinition
AnyPushTriggerDefinition
AnyTriggerDefinition
AnyTriggerPayloadSchemaFn
AnyTriggerPayloadSchemaShape
AnyWebhookTriggerDefinition
AnyWebhookTriggerHandleEventFn
ApiTokenAuthDefinitionInput
AppCredential
AppDefinition
Automation
AutomationOutput
AutomationRunExecution
Consumer
ExecuteActionFunction
GetAutomation
GetAutomationOpts
GetAutomationWhere
GetAutomations
GetAutomationsOpts
GetAutomationsWhere
GetCredentialOptionResult
GetCredentialOpts
GetLiveAutomations
GetLiveAutomationsOpts
GetLiveAutomationsWhere
GetPublicRolloutServiceUrl
GetTriggerPayloadSchemaOpts
HandleConsumerRequestOpts
HandlePushTriggerEvent
HandlePushTriggerEventOpts
HandleWebhookRequestJobOpts
InferActionInputParamsSchema
InferTriggerInputParamsSchema
InferTriggerPayloadSchema
JWTAuthDefinitionInput
OAuthScopeError
OnAutomationCreatedFunction
OnAutomationDeletedFunction
OnAutomationRunResultsCtx
OnAutomationRunResultsFunction
OnAutomationUpdatedFunction
PollingTriggerDefinition
PushTriggerDefinition
RequestHandler
RolloutConfig
TriggerEvent
UpdateAutomationTriggerSubscriptionData
UpdateAutomationTriggerSubscriptionDataOpts
UpdateAutomationTriggerSubscriptionDataWhere
UpsertCredentialOpts
UserError
WebhookTriggerDefinition
defineAction
defineActionInputParamsSchema
defineApiTokenAuth
defineApp
defineHTTPHandler
defineJWTAuth
defineOAuth1
defineOAuth2
definePollingTrigger
definePushTrigger
defineTriggerInputParamsSchema
defineTriggerPayloadSchema
defineWebhookTrigger
getAutomation
getAutomations
getCredential
getLiveAutomations
getPublicRolloutServiceUrl
getTriggerPayloadSchema
handleConsumerRequest
handlePushTriggerEvent
handleWebhookRequestJob
setupRollout
updateAutomationTriggerSubscriptionData
upsertCredential
@rollout/framework/ui
ActionCard
ActionCard
BooleanInput
BooleanInput
DropdownInput
DropdownInput
FileBrowserInput
FileBrowserInput
FindBy
FindBy
KeyValues
KeyValues
MultiSelectInput
MultiSelectInput
RichTextInput
RichTextInput
Spinner
Spinner
UIComponentProps
defineUIComponent
useApiBaseUrl
useConsumerToken
useCredentialKey
useHostAppContext
@rollout/framework
index
getTriggerPayloadSchema
Function getTriggerPayloadSchema
get
Trigger
Payload
Schema
(
opts
)
:
Promise
<
AnyTriggerPayloadSchemaShape
>
Parameters
opts
:
GetTriggerPayloadSchemaOpts
Returns
Promise
<
AnyTriggerPayloadSchemaShape
>