Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you have multiple fields, but only one of them is required, you should position the filters beside each other.

Available steps

This documentation is auto-generated from the source, hence it's very unlikely to contain mistakes.

Some additional manual documentation might be provided below. 

Available triggers

...

Type

...

Description

...

Exported Variables

...

Parameters

...

Asset Created Trigger

...

Triggers whenever an asset is created

...

  • @sourceAssetId
  • @sourceAssetItemId

...

  • key: upload_computer
  • Required: False
  • Type: string
  • Exported: False

...

Asset Folder Updated Trigger

...

Triggers whenever an asset moved between folders

...

  • @sourceAssetId
  • @sourceAssetItemId

...

Location State Changed

...

Triggered whenever a new asset is uploaded

...

  • @sourceAssetId
  • @sourceAssetItemId

...

  • key: new_location_state
  • Required: True
  • DefaultValue: 0
  • Type: options
  • options: Offline (offline), Online (online)
  • Exported: False

...

metadata

...

Triggers only if the metadata update was for the specified field.

...

  • @sourceAssetId
  • @sourceAssetItemId
  • @changedValue
  • @deleted

...

  • key: meta_field
  • Description: The metafield to watch for updates
  • Required: True
  • Type: metafield
  • Exported: False

...

CronScheduleTrigger

...

Member Created

...

Whenever a new member is created

...

  • @sourceMemberId
  • @sourceMemberItemId

...

Member Deleted

...

Whenever an existing member is deleted. Covers both soft and permanent deletes

...

  • @sourceMemberId
  • @sourceMemberItemId
  • @isSoft

...

  • key: only_soft_deletes
  • Description: True if the trigger should trigger only for soft deletes
  • Required: True
  • DefaultValue: true
  • Type: bool
  • Exported: False

...

Member Metadata Changed

...

Whenever the Metadata on a member changes

...

  • @sourceMemberId
  • @sourceMemberItemId

...

  • key: meta_field
  • Description: The metafield to watch for updates
  • Required: True
  • Type: metafield
  • Exported: False

...

Performance Test Trigger

...

  • @scheduledAt

...

  • key: identifier
  • Description: An identifier for the flow to limit execution
  • Required: True
  • Type: string
  • Exported: False

Available actions

...

Type

...

Description

...

Parameters

...

delay

...

Delays the execution with the Duration milliseconds

...

Download Asset Format

...

Downloads the given asset format to disk for processing

...

Get metadata from damapi

...

  • key: asset_item_id
  • Required: True
  • DefaultValue: @sourceAssetItemId
  • Type: int
  • Exported: False

...

Delete Asset Permanently

...

!DANGER! Permanently deletes an asset (there is NO WAY to recover after this)

...

Invoke Endpoint

...

Log

...

Logs a message to the logger

...

  • key: text
  • Required: True
  • Type: string
  • Exported: False

...

Query JSON

...

scale image

...

Scales an image to the specified height/width and format

...

Search

...

Y'know, for search...

...

Delete Asset

...

Soft deletes an asset (that is, keeps the actual file, but sets deleted bit)

...

  • key: asset_item_id
  • Description: The ItemId of the asset to be soft deleted
  • Required: True
  • DefaultValue: 0
  • Type: int
  • Exported: False

...

Variable set

...

Exports a value as a sample

...

Variable read

...

An export read sample

...

  • key: what
  • Required: True
  • Type: string
  • Exported: False

...

Create Folder Reference

...

Creates a folder reference for use in other steps that requires a folder value reference

...

Move Asset To Folder

...

Moves an asset into a specific folder

...

Remove Asset From All Channels

...

Remove Asset From Folder

...

Removes the given asset from a given folder

...

Remove Asset From Layout Folder Recursive

...

RePublish Asset

...

Triggers a republish of the specified asset

...

  • key: asset_id
  • Required: True
  • DefaultValue: @sourceAssetId
  • Type: int
  • Exported: False

...

Split Folder Reference

...

Splits a folder reference into individual parts, so they can be used by themselves

...

Split Tree value

...

Splits a tree value into its components

...

Set Bit Metafield

...

Updates a bit value

...

Set ComboValue Metafield

...

Updates a ComboValue metafield

...

Set Date Metafield

...

Updates a date field

...

Set EditComboValue Metafield

...

Updates the value of an edit combo value meta field

...

Set EditMultiComboValue Metafield

...

Updates the value of the edit multi combo value meta field

...

Set Float Metafield

...

Updates a float metafield

...

Set Int Metafield

...

Sets the value of the given int metafield

...

Set Link Metafield

...

Updates the value of a link meta field

...

Set MultiComboValue Metafield

...

Updates the value of a MultiComboValue field

...

Set Note Metafield

...

Updates the value of a note meta field

...

Set String Metafield

...

Sets the value of the given string metafield

...

Set Tree Metafield

...

Updates the value of a tree meta field

...

Add Member to Group

...

Adds a member to the given group

...

Move Member To Folder

...

Moves the member to a specific folder

...

Remove Access Rights

...

Removes the access rights for a given target from a given accessor
If you want to explicitly prevent an accessor from accessing an asset,
you probably need SetAccessRights instead, with Read and Write set to false.

...

Remove Member From Group

...

Removes a given member from a given group

...

Set Access Rights

...

Sets the access rights on a specific asset for a specific member

...

Convert Asset Id To Asset Item Id

...

Converts the given asset id to an asset item id

...

Convert Asset Item Id To Asset Id

...

Converts the given asset item id to an asset id

...

Convert Member Id To Member Item Id

...

Converts a member id into a member item id

...

Convert Member Item Id To Member Id

...

Converts the given member item id to a member id

...

Add Items To Collection

...

A list of assets will be added to the given collection. 

...

Create New Collection

...

Create a new collection with the given collection name. 

The action will export a 'CollectionId' after it has been executed.

...

Share Collection

...

Sharing a collection with a list of members, member groups or per email. 

...

  • key: collection_ids
  • Required: True
  • Type: list:int
  • Exported: False

Available filters

...

Type

...

Description

...

Parameters

...

Asset type filter

...

Limits execution to certain asset types

...

Forced Result

...

Forces a certain outcome from the filter

...

Metadata bit filter

...

Limits the execution if the expected Bit value does not equal the requested Metafield value

...

Metadata combo filter

...

Limits the execution if the expected Combo value does not equal the requested Metafield value

...

Metadata datetime filter

...

Limits the execution if the expected DateTime value does not equal the requested Metafield value

...

Metadata editcombo filter

...

Limits the execution if the expected Edit Combo value does not equal the requested Metafield value

...

Metadata editmulticombo filter

...

Limits the execution if the expected Edit Multi Combo value does not equal the requested Metafield value

...

Metadata float filter

...

Limits the execution if the expected Float value does not equal the requested Metafield value

...

metadata int filter

...

Limits the execution if the expected Int value does not equal the requested Metafield value

...

Metadata link filter

...

Limits the execution if the expected Link value does not equal the requested Metafield value

...

Metadata multicombo filter

...

Limits the execution if the expected Multi Combo value does not equal the requested Metafield value

...

Metadata note filter

...

Limits the execution if the expected Note value does not equal the requested Metafield value

...

Metafield string filter

...

Limits the execution if the expected String value does not equal the requested Metafield value

...

Metadata tree filter

...

Limits the execution if the expected Tree value does not equal the requested Metafield value

...

Bool Comparison filter

...

Compares 2 arbitrary booleans

...