Skip to main content

Event Fields

Activities and changes that occur in your Shopify store, providing an audit trail of actions taken by users and system processes

Updated this week

Note: Events are export-only and cannot be imported or updated through Altera.

General

ID

Description

Example Value

Unique event identifier

12345678

The unique identifier assigned to each event by Shopify. This field is export-only and cannot be imported.

Message

Description

Example Value

Description of what occurred

Product 'Blue Shirt' was updated

A human-readable description of the event that occurred. This field is export-only and cannot be imported.

Created At

Description

Example Value

When the event occurred

2023-06-01 10:00:00 -0400

The timestamp when the event was recorded. This field is export-only and cannot be imported.

Subject Type

Description

Example Value

Type of object affected

PRODUCT

The type of Shopify object that was affected by this event. Common values include:

  • ARTICLE: Blog articles

  • BLOG: Blogs

  • COLLECTION: Product collections

  • COMMENT: Blog comments

  • CUSTOMER: Customers

  • ORDER: Orders

  • PAGE: Static pages

  • PRODUCT: Products

  • VARIANT: Product variants

This field is export-only and cannot be imported.

Subject ID

Description

Example Value

Identifier of affected object

789012

The unique identifier of the specific object that was affected by this event. This field is export-only and cannot be imported.

Verb

Description

Example Value

Action that occurred

UPDATE

The type of action that was performed. Common values include:

  • CREATE: Object was created

  • UPDATE: Object was modified

  • DELETE: Object was deleted

  • PUBLISH: Object was published

  • UNPUBLISH: Object was unpublished

This field is export-only and cannot be imported.

Author

Description

Example Value

User who performed the action

The email address or identifier of the user who performed the action that triggered this event. This field is export-only and cannot be imported.

Arguments

Description

Example Value

Additional event details

{"price": "29.99", "old_price": "24.99"}

A JSON object containing additional details about what changed during the event. The structure varies depending on the type of event. This field is export-only and cannot be imported.

Body

Description

Example Value

Detailed event description

Price was updated from $24.99 to $29.99

A detailed description of what changed during the event. This field is export-only and cannot be imported.

Path

Description

Example Value

API path related to the event

/admin/api/2023-04/products/789012.json

The API endpoint path related to the event, if applicable. This field is export-only and cannot be imported.

Export Filters

You can use these filters to limit which events are exported:

  • created_at: Filter by when event occurred

  • subject_type: Filter by type of object (ARTICLE, BLOG, COLLECTION, COMMENT, etc.)

Did this answer your question?