Approval Rule and Approval Flow Messages

Messages that represent a change or an action performed on an Approval Rule or Approval Flow.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.

You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Approval Rule Messages

Messages that represent a change or an action performed on an Approval Rule.

Approval Rule Created

Approval Rule Status Set

Approval Rule Name Set

Approval Rule Description Set

Approval Rule Key Set

Approval Rule Predicate Set

Approval Rule Approvers Set

Approval Rule Requesters Set

Approval Rule Created

Generated after an Approval Rule is created.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`approvalRule` ApprovalRule	The Approval Rule that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Status Set

Generated after a successful Set Status update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleStatusSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`status` ApprovalRuleStatus	Status of the ApprovalRule after the Set Status update action.
`oldStatus` ApprovalRuleStatus	Status of the ApprovalRule before the Set Status update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Name Set

Generated after a successful Set Name update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the ApprovalRule after the Set Name update action.
`oldName` String	Name of the ApprovalRule before the Set Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Description Set

Generated after a successful Set Description update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleDescriptionSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`description` String	Description of the ApprovalRule after the Set Description update action.
`oldDescription` String	Description of the ApprovalRule before the Set Description update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Key Set

Generated after a successful Set Key update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`key` String	`key` value of the ApprovalRule after the Set Key update action.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleKeySet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldKey` String	`key` value of the ApprovalRule before the Set Key update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Predicate Set

Generated after a successful Set Predicate update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRulePredicateSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`predicate` String	Name of the ApprovalRule after the Set Predicate update action.
`oldPredicate` String	Name of the ApprovalRule before the Set Predicate update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Approvers Set

Generated after a successful Set Approvers update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleApproversSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`approvers` ApproverHierarchy	Approver hierarchy of the ApprovalRule after the Set Approvers update action.
`oldApprovers` ApproverHierarchy	Approver hierarchy of the ApprovalRule before the Set Approvers update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule Requesters Set

Generated after a successful Set Requester update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalRuleRequestersSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`requesters` Array of RuleRequester	RuleRequester of the ApprovalRule after the Set Requester update action.
`oldRequesters` Array of RuleRequester	RuleRequester of the ApprovalRule after the Set Requester update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Flow Messages

Messages that represent a change or an action performed on an Approval Flow.

Approval Flow Created

Approval Flow Approved

Approval Flow Rejected

Approval Flow Completed

Approval Flow Created

Generated after an Approval Flow is created.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalFlowCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`approvalFlow` ApprovalFlow	The Approval Flow that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Flow Approved

Generated after an approval in the Approval Flow.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalFlowApproved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`associate` CustomerReference	Reference to the Customer who approved the Approval Flow.
`order` OrderReference	Reference to the Order that received the approval.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Flow Rejected

Generated after an Approval Flow is rejected.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalFlowRejected"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`associate` CustomerReference	Reference to the Customer who rejected the Approval Flow.
`rejectionReason` String	Description of the reason why the Approval Flow was rejected.
`order` OrderReference	Reference to the Order that received the rejection.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Flow Completed

Generated after an Approval Flow is completed and reaches a final status.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"ApprovalFlowCompleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`status` ApprovalFlowStatus	Final status of the Approval Flow.
`order` OrderReference	Reference to the Order related to the completed Approval Flow.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Approval Rule and Approval Flow Messages

Approval Rule Messages.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Created.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Status Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Name Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Description Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Key Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Predicate Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Approvers Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Requesters Set.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Flow Messages.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Flow Created.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Flow Approved.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Flow Rejected.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Flow Completed.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Approval Rule Messages

Approval Rule Created

Approval Rule Status Set

Approval Rule Name Set

Approval Rule Description Set

Approval Rule Key Set

Approval Rule Predicate Set

Approval Rule Approvers Set

Approval Rule Requesters Set

Approval Flow Messages

Approval Flow Created

Approval Flow Approved

Approval Flow Rejected

Approval Flow Completed