Skip to main content

orderEventActions

List the event actions an order or quote send can be targeted at.

Returns the event actions configured for the given trigger in the Event Action Manager, default and non-default. Pass the ids of one or more of them as eventActionConfigIds to the matching trigger mutation (e.g. triggerQuoteSend for QUOTE_SEND) to run exactly those actions, e.g. a specific webhook or an alternative e-mail. A send without eventActionConfigIds runs the actions marked isDefault. With channelId, only the actions that run on that channel are listed; the trigger mutations accept only ids of actions that run on the channel of the send (their channelId, else the order's channel).

Possible errors:

  • EVENT_ACTION_CONFIGS_LIST_ERROR: Failed to list the event action configs in the Event Action Manager
  • VALIDATION_ERROR: Invalid trigger or channel id provided
  • FORBIDDEN: Insufficient permissions to list order event actions

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

orderEventActions(
  input: OrderEventActionSearchInput!
): [OrderEventActionOption!]!

Arguments​

orderEventActions.input ● OrderEventActionSearchInput! non-null input​

The trigger to list the event actions for, and optionally the channel they must run on

Type​

OrderEventActionOption object​

An event action configured for an order or quote trigger in the Event Action Manager, that a send can be targeted at