Action

Indicates if this action run is part of a retry attempt
If it's not null, it's a retry action run

ActionAttributes

The execution identifier that was given to the spi provider when we invoked the action

executionIdentifier

The result of invoking the action. Must conform to the output schema configured by the action provider.

result

ActionCompletedRequest

ActionData

bodyAsJson

ActionEvent

The type of the initiator (e.g., app, user)

type

ActionInitiator

ActionRetryRequest

Whether the option to add a condition is disabled for the automation.

disableConditionAddition

Whether the option to add a delay is disabled for the automation.

disableDelayAddition

List of actions that cannot be deleted.
Default: Empty. All actions are deletable by default.

permanentActionIds

List of actions that cannot be edited.
Default: Empty. All actions are editable by default.

readonlyActionIds

ActionSettings

actions

rootActionIds

ActionsData

Activation

activationId

externalEntityId

status

statusChangedDate

ActivationActionStatusChanged

actionId

activationStatus

configurationId

enrichedEventPayload

name of the event. intended to keep backwards compatibility, probably not in use.

eventName

eventSlug

externalId

output

rawEventPayload

ActivationContext

ActivationContinuedAfterSchedule

Automation V2. Used for reporting domain event until activation request will be deprecated.

eventPayload

Trigger entity for the activation, available for v2 and v3 automations only

triggerSchema

ActivationRequest

Optional - external entity id that this activation is related to

payload

scheduleDate

scheduleId

Scheduled action identifier - with the intent to execute that action's post actions

scheduledActionId

ActivationResumeAfterDelay

ActivationScheduleCompleted

requestedDate

ActivationScheduleRequested

ActivationSource

ActivationStatusChanged

walletId

AddCustomerReferenceRequest

AddCustomerReferenceResponse

Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.

fieldPath

Aggregation name, returned in `aggregations.results.name`.

name

Type of aggregation to perform. Must align with the corresponding aggregation field.

Aggregation

results

AggregationData

Aggregation type. Must align with the corresponding aggregation field.

AggregationResults

Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values.

Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define.

Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.

Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.).

Flattened list of aggregations, where each aggregation is nested within previous one.

AggregationType

actionKey

appId

inputMapping

Optional output schema of the action. It will be used instead the action schema in case it's provided.

overrideOutputSchema

List of IDs of actions to run in parallel once the action completes.

postActionIds

Array of conditions determining whether to skip the action in the automation flow.
The action will be skipped if any of the expression groups evaluate to `true`.
Actions following a skipped action will still run.

skipConditionOrExpressionGroups

AppDefinedAction

AppDefinedActionInfo

code

data

description

ApplicationError

External ID to correlate multiple sites to an automation

appDefinedExternalId

ApplicationOrigin

AsyncAction

AuditInfo

Object that defines the automation's trigger, actions, and activation status.

Information about the creator of the automation.

Date and time the automation was created.

createdDate

Draft info (optional - only if the automation is a draft)

Automation name that is displayed on the user's site.

namespace

Defines how the automation was added to the site.

origin

Revision number, which increments by 1 each time the automation is updated. To prevent conflicting changes,the current revision must be passed when updating the automation. Ignored when creating an automation.

revision

The entity that last updated the automation.

Date and time the automation was last updated.

updatedDate

Automation

Map of all actions that the automation may execute.
The key is the action ID, and the value is the action configuration.

List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel.

AutomationConfiguration

AutomationIdentifier

AutomationInfo

Whether the option to delete the automation from the site is disabled.
Default: `false`

disableDelete

Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
Default: `false`

disableStatusChange

Whether the automation is hidden from users.
Default: `false`

hidden

Whether the automation is read-only.
Default: `false`

readonly

AutomationSettings

activationRequests

BatchActivationRequest

Information about the billing address of the buyer.

The street address of the billing address.

address1

An optional additional field for the street address of the billing address.address

address2

city

The company of the person associated with the billing address.

company

The name of the country of the billing address.

country

countryCode

latitude

longitude

The name of the region of the billing address.

state

stateCode

BillingInfo

BlockType

value

BoolValue

Number of items that couldn't be processed.

totalFailures

Number of items that were successfully processed.

totalSuccesses

Number of failures without details because detailed failure threshold was exceeded.

undetailedFailures

BulkActionMetadata

Repeated list of external_entity_id, representing the related resources' IDs.

externalEntityIds

gger key whose events you want to cancel.
For example, `form_submitted` or `invoice_due`.

triggerKey

BulkCancelEventRequest

Metadata for the overall bulk action, including success and failure counts.

List of results for each item in the bulk cancel event request.

Trigger key related to the canceled event.

BulkCancelEventResponse

ID of the related resource in GUID format.

Metadata of the item, including its ID and success or failure status.

BulkCancelEventResult

expectedAmount

metaSiteId

BulkDeleteGiftCardsByFilterRequest

jobId

BulkDeleteGiftCardsByFilterResponse

ID of the bulk that issued the gift card or transaction.

bulkId

Indicates whether the gift card or transaction is a liability.

liability

note

BulkOptions

Repeated list of event details for bulk reporting.

eventsInfo

ey as defined in your app's trigger configuration
in the app dashboard.
For example, `form_submitted` or `invoice_due`.