User manual

Every screen,
in the order you'll meet it.

Read it start to finish on your first day, or jump to the section you're stuck on. Each part assumes you've done the one before it.

Covers Auditor 1.x · reading time about 12 minutes

1. Before you start

Auditor records supported activity from your BigCommerce store and displays the recorded information in the dashboard. It can also retrieve additional staff activity from the BigCommerce Staff Action Log when the scraping process is used.

You'll need:

  • A BigCommerce store you can administer, so you can install the app and approve the required permissions.
  • The BigCommerce account credentials required when the staff log scraping process needs to access the Staff Action Log.
Activity starts from your connection. Auditor does not automatically recreate historical activity that occurred before the relevant data was available to the app. Staff log scraping uses its configured date and last scraping point to determine which staff activities should be processed.

2. Install and permissions

  1. Install Auditor from your BigCommerce store. Start the installation process from the BigCommerce app installation flow.
  2. Approve the requested permissions. The app requests the access required to connect your store, receive supported webhook events, and retrieve information needed for activity and staff log processing.
  3. Complete token verification. After installation, the app verifies the connection and redirects you to the dashboard.
  4. Activity capture begins. When a supported activity occurs in BigCommerce, the registered webhook sends the event details to the app, where they are recorded and made available in the dashboard.
  5. Configure staff log scraping when required. Set the relevant date in the app preferences. The scraping process uses this date together with the last recorded scraping point to identify newer staff activity.

When new staff activity is found, it is processed using its BigCommerce timestamp and added to the dashboard page.

Uninstalling

You can uninstall Auditor from your BigCommerce store. After the app is uninstalled, its connection to the store is no longer available for receiving new activity through the app.

3. Your first ten minutes

Follow these steps to verify that your store is connected and activity is being recorded:

  1. Open the dashboard after completing the installation and token verification.
  2. When a supported activity occurs in your BigCommerce store, the registered webhook sends the event details to Auditor, where the activity is recorded and displayed on the Dashboard page.
  3. Open a recorded activity to review the information provided by BigCommerce. The available details depend on the type of activity.
  4. Configure the staff log scraping date in your preferences when you want to retrieve staff activity from BigCommerce.
  5. Staff activities retrieved through scraping are displayed on both the Dashboard page.

4. Reading an entry

Activities captured from BigCommerce are displayed in a consistent format so you can quickly understand what happened, when it happened, and which store activity was recorded. Staff activities retrieved through scraping are also added to the activity records using the timestamp provided by BigCommerce.

activity_record · one entry, expanded
  • occurred at2026-08-26 14:22:07 IST
  • eventproduct.updated
  • userStaff activity details when provided by BigCommerce
  • sourcewebhook or staff log
  • resourceProduct or other affected BigCommerce resource
  • storeConnected BigCommerce store
Field What it tells you
occurred_at The timestamp associated with the activity as provided by BigCommerce.
event The type of activity recorded from the BigCommerce event or staff log.
user The available staff or user information associated with the activity. The value depends on the information provided by BigCommerce.
source Identifies whether the activity was received through a webhook or retrieved from the BigCommerce Staff Action Log.
resource The BigCommerce resource associated with the activity, when the event provides that information.
store Identifies the connected BigCommerce store associated with the activity.

Activity information

Auditor displays the information provided by BigCommerce for each recorded activity. The available details can vary depending on the type of event and the information provided by BigCommerce.

When staff activity is recorded

Staff activity is retrieved from the BigCommerce Staff Action Log through the scraping process. Auditor uses the configured scraping date and the last recorded scraping point to identify the relevant staff activities.

5. The dashboard

The Dashboard provides a central view of the activity recorded for your connected BigCommerce store.

  • Activity list. Recorded webhook events and staff activities are displayed in the dashboard so you can review activity from one place.
  • Activity details. Open an activity to review the information available for that event.
  • Staff activity. Staff activities retrieved through scraping are also added to the Dashboard based on their BigCommerce timestamp.

The Dashboard and the Staff Log page provide access to the staff activity retrieved from BigCommerce. The Staff Log page is dedicated to reviewing staff actions, while the Dashboard provides the broader activity view.

6. Filters and search

Use the available filters and search options to narrow the activity displayed in the Dashboard. This makes it easier to find a particular activity without going through the complete activity list.

Filter or search Use it when
Channel You want to narrow the results to activity from a particular channel when channel information is available.
Date You want to review activity from a particular period.
Event type You want to narrow the results to a particular type of BigCommerce activity.
User or staff You want to find activity associated with a particular user or staff account when that information is available.
Search You want to find activity using available text or activity details.

Filters and search help narrow the records shown in the Dashboard so you can focus on the activity relevant to your investigation.

7. Staff Log

The Staff Log page is used to retrieve staff activity from the BigCommerce Staff Action Log and store the retrieved records in Auditor. The page also provides scraping progress, live activity information, and the status of the most recent scraping process.

  1. Open the Staff Log page. Navigate to Staff Log from the top navigation menu.
  2. Enter the BigCommerce login details. Provide the required BigCommerce user ID/email and password, and confirm the BigCommerce account/store details.
  3. Check the last scraping status. The Last Scraping section displays the store that was previously scraped and the date and time of the last scraping process.
  4. Start the scraping process. Click Start Scraping. Auditor signs in to BigCommerce and processes the Staff Action Log. An OTP verification prompt may appear during the login process.
  5. Monitor the scraping progress. The Scraping Progress section displays the current status, current page, number of records found, and elapsed time while scraping is running.
  6. Review live activity. The Live Activity section displays messages and updates generated while the scraping process is running.

Scraping Status notification

The notification bell in the bottom-right corner provides quick access to the current scraping status. If a scraping status notification is available, a badge is displayed on the bell icon.

  1. Click the notification bell. A Scraping Status sidebar opens on the right side of the screen.
  2. Review the last scraping date. The sidebar shows the date and time when the most recent scraping process was completed.
  3. Review the current time. The current date and time are displayed for comparison with the last scraping date.
  4. Check the days since the last scraping. Auditor calculates and displays the number of days that have passed since the most recent scraping process.
  5. Close the sidebar. Click the × icon in the upper-right corner of the Scraping Status panel to return to the Staff Log page.

Last scraping point

Auditor keeps track of the most recent successful scraping point. This information helps identify when staff activity was last collected and gives the user a clear indication of how recently the Staff Action Log was processed.

8. Staff Activity Notifications (Upcoming Feature)

Staff activity notifications are planned for a future release of Auditor. This feature will provide notifications when new staff activity is detected during the staff log scraping process.

Currently, newly retrieved staff activity can be reviewed from the Dashboard page. Automatic email notifications for new staff activity are not yet available.

Upcoming: Email notifications for newly detected staff activity will be introduced in a future version of Auditor.

9. People and roles

Role Can Cannot
Owner Everything, including plan and uninstall —
Admin Read the log, change alerts, recorded events and people Change the plan or uninstall
Reviewer Search, filter and export the log Change any setting

Reviewer exists for accountants, agencies and auditors: they get the record without getting your store. Invite them under Settings → People, and remove them when the engagement ends.

10. Settings

The Settings Center is used to manage the main Auditor configuration, including connected BigCommerce channels, the application access token, webhook subscriptions, and application preferences.

  • Channel Configuration. View the connected BigCommerce channels and refresh channel information.
  • Account Token. View or update the access token used by Auditor to connect with BigCommerce.
  • Webhook Management. View, add, enable, disable, or remove configured BigCommerce webhooks.
  • Application Preferences. Configure the default event age, Dashboard page size, and scraping alert threshold.

11. Retention and Deletion

Auditor currently provides a 365-day data retention period for all users under the free plan. Activity records are stored and remain available in the application during this retention period.

In future paid plans, the retention period may vary depending on the selected plan. When a record reaches the end of the retention period for a plan, it may be moved to an archive for a limited period before being permanently removed.

  • Current Free Plan. Activity data is retained for up to 90 days.
  • Future Paid Plans. Data retention and archive periods may vary depending on the plan.
  • Archived Data. Data that reaches the applicable retention limit may be temporarily archived before permanent deletion.

Retention limits for paid plans and the duration of the archive period will be defined when those plans become available.

12. How to run an investigation

The most common task, in the order that works:

  1. Start from the resource, not the date. If you have the SKU, order number or customer ID, filter by it. You'll usually have the answer in one screen.
  2. Widen the date range before concluding something is missing. The default is seven days.
  3. Read the previous value. It tells you what to restore, and often who would have had a reason to change it.
  4. Follow the actor. If it's a person, ask them. If it's an app, check that app's own logs for the same timestamp.

14. Event glossary

Event Meaning
product.created A new product exists, with its opening values.
product.updated A product field changed — price, stock, title or status.
product.deleted A product was removed; last known values retained.
order.created A new order, with its number and total.
order.updated Status or fulfilment moved.
order.refunded A refund was issued, with the amount and who issued it.
customer.created A new customer record, with its signup source.
customer.updated Customer details edited — email, address.
inventory.updated Stock level changed, old and new.
settings.changed Payment, shipping or tax settings edited.
auth.login A staff session opened.
auth.login.failed A sign-in attempt failed; counted per IP and account.
staff.permission.changed A role was granted or revoked.
api.token.used An API key called an endpoint.
app.installed An app was installed or removed.
webhook.failed A delivery failed, with the reason.
webhook.retried A delivery was retried, with the attempt number.
export.generated Someone exported a view — who, what and when.

15. Getting help

The help centre answers the common questions and is searchable. If you'd rather ask, write to us with the store address, roughly when the change happened, and what you expected to see. Those three things are usually enough for us to trace the event and answer on the first reply.

Help centre · What it logs · How it works · Contact us