DocumentationJourney OrchestrationJourney Orchestration

journeyStep events action execution fields sharing-execution-fields

Last update: Mon Jul 12 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Intermediate
  • User

This mixin will be shared by the journeyStepEvent and journeyStepProfileEvent.

If the step has an action to be processed, those fields will be added to the event payload.

actionID

ID of the action that is being executed.

Type: string

actionName

Name of the action. If no name has been set, the stepName will be taken.

Type: string

actionType

Type of the action.

Type: string

actionParameterized

Indicates if the action is parameterized or not.

Type: boolean

actionExecutionTime

The amount of time (in milliseconds) taken to execute a current action.

Type: long

actionExecutionError

Type of error that happens when the action is called.

Type: string

Values:

  • http
  • capping
  • timeout
  • error

actionExecutionErrorCode

Code for action execution error. Present if the error has a code, such as an HTTP one.

Type: string

actionExecutionOriginError

A timeout can occur, in two cases:

  • at the first attempt an action is executed. In this case, the execution is not finished, so there is no underlying error
  • on a retry: in this case, the actionExecOrigError/actionExecOrigErrorCode describes the error encountered on the attempt before the retry.

For instance, an email is being sent and an HTTP 500 error is returned at the first attempt. The fetch is retried, but the duration of the 2 attempts exceeds the timeout. Then the action execution is tagged as timedout. The action part will look like:

    ...
    "actionId": "myActionId",
    "actionName": "My mail sending",
    "actionType": "acsRestAction",
    "actionParameterized": true,
    "actionExecError": "timedout",
    "actionExecOrigError": "http",
    "actionExecOrigErrorCode": "500"

Type: string

actionExecutionOriginCode

Error code of the actionExecOrigError.

Type: string

actionBusinessType

Indicates the type of action.

Values:

  • builtin
  • ACS Email
  • ACS SMS
  • ACS Push
  • customer
  • Epsilon
  • …

Type: string

deliveryJobID

This describes the delivery Job Id for the batch Journey.

Type: string

batchDeliveryID

This describes the delivery Id for the batch Journey.

Type: string

fromSegmentTrigger

This describes if the Batch Journey is triggered from Audience Segment.

Type: boolean

actionSchedulerCount

Count of scheduler notification requests sent to the scheduler service during the step processing.

Type: long

recommendation-more-help
4f4a00c1-77c9-4eee-84df-bbe6206c3ab9