docs/classes/management.SDK.ActionsClient.html
versionsexecutionsmodulestriggers
listcreategetdeleteupdatedeploytest
_options_versions_executions_modules_triggers
get versions(): VersionsClient
get executions(): ExecutionsClient
get modules(): ModulesClient
get triggers(): TriggersClient
new ActionsClient(options: BaseClientOptions): ActionsClient
list(
request?: ListActionsRequestParameters,
requestOptions?: ActionsClient.RequestOptions,
): Promise<Page<Management.Action, ListActionsPaginatedResponseContent>>
Retrieve all actions.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.list({ triggerId: "post-login", actionName: "actionName", deployed: true, page: 1, per_page: 1, installed: true })Copy
create(
request: CreateActionRequestContent,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<CreateActionResponseContent>
Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.create({ name: "name", supported_triggers: [{ id: "post-login" }] })Copy
get(
id: string,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<GetActionResponseContent>
Retrieve an action by its ID.
The ID of the action to retrieve.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.get("id")Copy
delete(
id: string,
request?: DeleteActionRequestParameters,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<void>
Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
The ID of the action to delete.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.delete("id", { force: true })Copy
update(
id: string,
request?: UpdateActionRequestContent,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<UpdateActionResponseContent>
Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
The id of the action to update.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.update("id")Copy
deploy(
id: string,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<DeployActionResponseContent>
Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
The ID of an action.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.deploy("id")Copy
test(
id: string,
request: TestActionRequestContent,
requestOptions?: ActionsClient.RequestOptions,
): HttpResponsePromise<TestActionResponseContent>
Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.
The id of the action to test.
OptionalrequestOptions: ActionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.test("id", { payload: { "key": "value" } })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Protected_versions_versions: VersionsClient | undefined
Protected_executions_executions: ExecutionsClient | undefined
Protected_modules_modules: ModulesClient | undefined
Protected_triggers_triggers: TriggersClient | undefined
Member Visibility
ThemeOSLightDark
Accessors versionsexecutionsmodulestriggers Constructors constructor Methods listcreategetdeleteupdatedeploytest Properties _options_versions_executions_modules_triggers