Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Security
Platform security resources
Events available in Audit
Events available in Audit
7 min read

Below, you will find a list of the potential events available in Audit for each app.

In case you encounter an event in Audit which has not been included in this list, please inform us through the documentation feedback page.

In the Audit filter options, you can find Shipping Options, Profile System, and Billing options besides the applications listed in this guide. Since these options refer to internal resources or features in closed beta, most accounts will not have events associated with them.

OMS

ActionEvent descriptionEvent details
Start HandlingInforms VTEX that the store has started handling an order. This helps order workflow.Order ID.
Change StatusChange in order status.Order ID.
Shipping NotificationShipping notification of a certain order.Order ID.
Payment NotificationPayment notification of a certain order.Order ID.
Save ConfigurationChange in price module settings.Short description of the change.
Resend Last EmailResending the last email related to the order in the Message Center.Order ID.

Orders

ActionEvent descriptionEvent details
Change StateChange in order status.Order ID.
Order CancellationCancellation of an order.Order ID.
Start HandlingAction that signals to VTEX that the store has started handling a given order. This triggers the continuation of the flow of this order.Order ID.
Notify PaymentPayment notification for a given order.Order ID.

Order Authorization

ActionEvent descriptionEvent details
Create RuleCreation of a price divergence rule.Rule ID.
New DimensionCreation of dimensions for order approvals, such as order value range, list of emails authorized to carry out order approval, among others.Dimension ID.
Delete DimensionExclusion of dimensions for order approvals, such as order value range, list of emails authorized to carry out order approval, among others.Dimension ID.
Update DimensionUpdate in dimensions for order approvals, such as order value range, list of emails authorized to carry out order approval, among others.Dimension ID.
Update RuleEdition of a price divergence rule.Rule ID.
Delete RuleExclusion of a price divergence rule.Rule ID.

Inventory & Shipping

ActionEvent descriptionEvent details
Carrier CreateCarrier creation.Carrier ID.
Carrier UpdateCarrier update.Carrier ID.
Dock CreateLoading dock creation.Loading dock ID.
Dock UpdateLoading dock update.Loading dock ID.
Warehouse UpdateWarehouse update.Warehouse ID.
warehouse deactivateWarehouse deactivation.Warehouse ID.
Pickup Point SavePickup point creation or update.Pickup point ID.
UPDATE-ITEM-AVAILABILITYItem availability update.Previous and new item quantity, SKU ID, and warehouse ID. Example: The quantity of 17_andreia-estoque-sp was updated from 30.0 to 200.0.
item-availability-deleteItem availability deletion.SKU ID and warehouse ID. Example: 112233_andreia-estoque-sp was deleted.
Item Availability UpdateItem availability update.Previous and new item quantity, SKU ID, and warehouse ID. Example: The quantity of 17_andreia-estoque-sp was updated from 30.0 to 200.0.
Pickup Point DeletePickup point deletion.Pickup point ID.
Carrier New Freight ValuesFreight table update.Shipping policy ID.
Holiday UpdateHoliday update.Holiday ID.
Polygon CreatePolygon creation.Polygon ID.
Holiday CreateHoliday creation.Holiday ID.
Holiday DeleteHoliday deletion.Holiday ID.
Reservation CreateSKU reservation creation.Item quantity, SKU ID, and warehouse ID. Example: A quantity of 1.0 from 1_1_1 was reserved.
Reservation CancelSKU reservation cancellation.Item quantity, SKU ID, and warehouse ID. Example: The reservation of 1.0 from 2000534_1_1 was canceled.

Catalog (Admin)

ActionEvent descriptionEvent details
Product ActivationProduct activation. This event is recorded only when changes are made in the Admin. Changes made via spreadsheet are not recorded in this event.Product ID.
Product Commercial Condition ChangeChange in product commercial condition.Product ID and changed list of conditions.
SKU Attachment AssociationSKU Attachment Association.SKU ID, name and attachment ID.
Archive UploadFile delivery.File name.
Field ActivationCatalog field activation.Field name, ID and status.
SKU Seller BindingSKU and seller binding.Seller’s ID, SKU ID in seller’s catalog and SKU ID in the marketplace catalog.
SKU Seller UnbindingRemoval of SKU and seller binding.Seller’s ID, SKU ID in seller’s catalog and SKU ID in the marketplace catalog.
SKU Seller RemovalRemoval of seller SKU.SKU ID in seller’s catalog.

Catalog (API)

ActionDescriptionEvent details
SKU Seller Binding RemovalSKU Binding Removal.SKU ID in seller and seller ID.
Seller UpdateSeller update.Seller ID.
Seller CreationSeller creation.Seller ID.
SKU Seller Binding ActivationSKU binding activation.SKU ID in seller and seller ID.
SKU Seller Binding InactivationSKU binding inactivation.SKU ID in seller and seller ID.

Prices

ActionDescriptionEvent details
Put PriceCreation or change of a SKU price.SKU ID.
Save Price TableCreation or change of a price table.Identifies the created or changed table.
Save Price TablesCreation or change of multiple price tables.Identifies the created or changed tables.
Price DeletedDeletion of a SKU price.SKU ID.
Save ConfigCreation or change of price settings.Identifies the created or changed configuration.
Fixed Price ModifiedChange of fixed price.Identification of the fixed price changed.
Put Catalog StepCreation or change of a price rule.Price rule created or changed.
Deleted Fixed Prices From TableDeletion of fixed price from the related price table.Identification of the table and the deleted price.
Compatibility Post PricesChange of price using the compatibility API with the PricingV1 contractIdentification of the changed price.
Change Rnb ConfigChange in price settings for new accounts.Name of the account that made the change.

Promotions

ActionEvent descriptionEvent details
Archive CouponArchived a coupon.Coupon code.
Unarchive CouponUnarchived a coupon.Coupon code.
Change Rate ConfigurationChange in fee settings.Fee configuration ID.
Change Promotion ConfigurationChange in promotion settings.Promotion configuration ID.
Change Coupon ConfigurationCoupon change.Coupon code.
Unarchived CalculatorUnarchived promotion or fee.Promotion or fee configuration ID.
Archived CalculatorArchived promotion or fee.Promotion or fee configuration ID.

Subscriptions

ActionEvent descriptionEvent details
SubscriptionGroup UpdateUpdate of a subscription group.Subscription group ID.
Subscription CreateCreation of a subscription.Subscription ID.
SubscriptionGroup Place OrderCreation of a subscription order within a subscription group.Subscription group ID.
SubscriptionGroup RetryExecution of an attempt to generate a subscription cycle.Subscription group ID.
Subscription DeleteDeletion of a subscription.Subscription ID.
Plan CreateCreation of a subscription plan, where stores can associate different items and SKUs.Subscription plan ID.
Plan UpdateUpdate of a subscription plan, where stores can associate different items and SKUs.Subscription plan ID.
Subscriber Fetch By EmailAudit of who has searched the profile data of a store customer who has subscriptions, based on the customer's email.ID of the user who carried out the search.
SubscriptionGroup Create For OrderCreation of a subscription group for an existing order.Subscription group ID.
Plan DeleteDeletion of a subscription plan.Subscription plan ID.
Store Payments UpdateUpdate in the payment methods that the store accepts for subscriptions.Account name.

Wallets

ActionEvent descriptionEvent details
TOGGLE_WALLETActivate or deactivate a digital wallet.toggle-wallet-action

Gift Card

ActionEvent descriptionEvent details
LIST_GIFT_CARDVisualization of the gift card list.list-gift-card
EXPORT_GIFT_CARDExport of gift cards.export-gift-card
EDIT_GIFT_CARDChange in gift card value.add-gift-card-value
CREATE_GIFT_CARDCreation of gift cards.create-multiple-gift-cards

Checkout

ActionEvent descriptionEvent details
SaveOrderFormConfigurationChange in OrderForm settings, which is in charge of running the store checkout.Action description (“configurated OrderForm”)

Portal CMS

ActionEvent descriptionEvent details
File UpdateChange in portal file.File name and ID changed.
File UploadPortal file upload.File name changed.
File DeletedFile removal.File name and ID changed.

License Manager

ActionEvent descriptionEvent details
Block AppTokenApplication key blocking.Application key blocked.
Accept Sponsor InviteAccept the invitation to become the sponsor user.ID of the user who accepted the invitation.
Save UserCreate a user or change user information.User ID.
Save AccountCreate an account or edit account information.Created or changed account.
Change RoleAccess role editing.Role edited.
Delete RoleDeletion of a role.Role deleted.
Unblock AppTokenApplication key unlocking.Unblocked application key.
Resource Access AllowedResource access allowed.Resource key and user ID to which access has been allowed.
Cancel Sponsor InviteCancellation of sponsor user invitation.ID of invited user.
Delete UserDeletion of a user.ID of deleted user.
Update BindingBinding update.Binding updated.
Resource Access DeniedResource access denied.Resource key and user ID to which access was denied.
Create New AppTokenCreation of application key.Application key created.
Create Sponsor InviteCreation of a sponsor user invitation.ID of invited user.

VTEX ID

ActionEvent descriptionEvent details
PasswordCreatedCreation of a first-time password in the store or the VTEX AdminUser ID.
PasswordUpdatedChange of store or VTEX Admin password by the user.User ID.
IdentityProviderChangedIdentity provider configuration change. For example: Creating a customized OAuth integration and changing information in an existing OAuth configuration.Identity provider.

Master Data

ActionEvent descriptionEvent details
DeleteDocumentDeleted document.Document ID.
UpdateSchemaCreated or updated schema on Master Data v2.Schema name.
DeleteSchemaDeleted schema on Master Data v2.Schema name.

Headless CMS

ActionEvent descriptionEvent details
TRY_PUBLISHINGAttempt to publish a page.Event ID.
TRY_PUBLISH_IN_RELEASEAttempt to publish a release.Event ID.
TRY_UNPUBLISHINGAttempt to unpublish a page.Event ID.
RESTORE_CONTENTContent restore.Event ID.
TRY_UPDATING_DRAFTAttempt to update a draft.Event ID.
TRY_UNPUBLISHING_AND_OVERWRITINGAttempt to unpublish and overwrite a page.Event ID.
done.invoke.deleteContentDelete content.Event ID.
done.invoke.deleteContentVariantDelete content version.Event ID.
Create new mediaCreate media file.Event ID.
Delete mediaDelete media file.Event ID.

In the Action column, all Headless CMS events also display the following information:

  • CONTENT_ID: unique identifier of the content.
  • VARIANT_ID: unique identifier of the content version.
  • WORKSPACE: workspace where the action occurred.

Seller Management

ActionEvent detailsEvent description
Update SellerChange in a seller.Seller ID.
Save SellerSeller creation.Seller ID.

Site Editor

ActionEvent descriptionEvent details
Schedule changeSchedules content editing.Changed entity ID.
Edit content blockEdits the content block.Changed entity ID.
Create content blockCreation of a content block.Changed entity ID.
Activate content block versionActivates the content block version.Changed entity ID.
Reset content block versionResets the content block version.Changed entity ID.
Delete content block versionDeletes the content block version.Changed entity ID.
Edit styleEdits the style.Changed entity ID.
Create new styleCreates a new style.Changed entity ID.
Select main styleSelects the main style.Changed entity ID.
Delete styleDeletes the style.Changed entity ID.
Copy binding contentCopies the binding content.Changed entity ID.

Ad Network

ActionEvent descriptionEvent details
Create adsCreation of a new ad.Ad ID.
Create campaignCreation of a new campaign.Campaign ID.
Update adsUpdate of an ad.Ad ID.
Update campaignUpdate of a campaign.Campaign ID.
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback