Colossal

The Colossal app emits events when things happen in your project: orders placed, products published, payments processed. These events trigger automations. Some event payloads are privacy-safe snapshots. Customer name and email fields can be blank, and checkout payloads may omit shopper details when the event does not need them. Each event follows a consistent envelope format:

object

Show properties

string

The event type identifier

integer

Organization ID

integer

Project ID

string

Primary entity identifier

string

Type of entity (e.g. "order", "product", "invoice")

object

Event-specific payload (see below)

string | null

Optional trace/correlation ID

string

One of "user", "workflow", or "system"

string

ISO 8601 UTC timestamp

Orders

ORDER_CREATED

Cart converted into an order during checkout, before payment.

object

Show properties

string

Unique order identifier

number

Order total

number

Order total

Customer

Customer details

LineItem[]

Items in the order

ORDER_CONFIRMED

Payment processed successfully, before fulfillment.

object

Show properties

string

Unique order identifier

number

Order total before tax

number

Order total including tax

number

Subtotal before tax

number

Tax amount

Customer

Customer details

LineItem[]

Items in the order

boolean

Whether order contains a subscription

ORDER_COMPLETED

Order fully complete. Payment processed and fulfillment finished.

object

Show properties

string

Unique order identifier

number

Order total before tax

number

Order total including tax

number

Subtotal before tax

number

Tax amount

Customer

Customer details

LineItem[]

Items in the order

boolean

Whether order contains a subscription

string

Fulfillment method (e.g., digital)

ORDER_CANCELLED

Order cancelled.

object

Show properties

string

Unique order identifier

string

ISO 8601 timestamp of cancellation

number

Order total

string

Currency code

Customer

Customer details

string

Payment provider

string

Reason, if provided

ORDER_REFUNDED

Order refunded.

object

Show properties

string

Unique order identifier

string

ISO 8601 timestamp of refund

number

Order total refunded

string

Currency code

Customer

Customer details

string

Payment provider

string

Reason, if provided

Customers

CUSTOMER_CREATED

New customer account created.

object

Show properties

string

Unique customer identifier

string

Customer email address

string

Customer full name

CUSTOMER_UPDATED

Customer details updated.

object

Show properties

string

Unique customer identifier

string

Customer email address

string

Customer full name

string[]

List of fields that changed

Invoices

INVOICE_CREATED

New invoice created.

object

Show properties

string

Unique invoice identifier

string?

Human-readable invoice number

string?

Customer identifier

string?

Associated order identifier

string

Currency code (e.g., USD)

integer

Subtotal in cents

integer

Tax in cents

integer

Total in cents

string

Invoice status

string

Invoice source (e.g., order)

INVOICE_PAID

Invoice paid.

object

Show properties

string

Unique invoice identifier

string?

Human-readable invoice number

string?

Customer identifier

string?

Associated order identifier

string

Currency code

integer

Total paid in cents

Payments

PAYMENT_SUCCEEDED

Payment completed successfully.

object

Show properties

string

Unique payment identifier

string

Associated invoice identifier

integer

Amount in cents

string

Currency code

string

Payment provider (e.g., stripe)

string?

Payment method (e.g., card)

string?

Card brand (e.g., visa)

string?

Last 4 digits of card

string?

Provider transaction ID

PAYMENT_FAILED

Payment failed.

object

Show properties

string

Unique payment identifier

string

Associated invoice identifier

integer

Amount in cents

string

Currency code

string

Payment provider

string?

Payment method

string?

Failure code

string?

Failure message

string?

Decline code from provider

Products

PRODUCT_CREATED

New product created.

object

Show properties

string

Unique product identifier

string

Product name

string

URL-friendly handle

string?

Product description

object?

Variant property definitions

PRODUCT_UPDATED

Product details modified.

object

Show properties

string

Unique product identifier

string

Product name

string

URL-friendly handle

string?

Product description

object?

Variant property definitions

boolean

Whether product is archived

string[]

List of fields that changed

PRODUCT_PUBLISHED

Product made visible in the storefront.

object

Show properties

string

Unique product identifier

string

Product name

PRODUCT_DRAFT_DISCARDED

Product draft discarded.

object

Show properties

string

Unique product identifier

PRODUCT_ARCHIVED

Product archived.

object

Show properties

string

Unique product identifier

PRODUCT_UNARCHIVED

Product restored from archive.

object

Show properties

string

Unique product identifier

Product variants

PRODUCT_VARIANT_CREATED

New variant added to a product.

object

Show properties

string

Unique variant identifier

string

Parent product identifier

string?

Variant name

object?

Variant properties (e.g., {"tier": "pro"})

integer?

Inventory count

PRODUCT_VARIANT_UPDATED

Variant details changed.

object

Show properties

string

Unique variant identifier

string

Parent product identifier

string?

Variant name

object?

Variant properties

integer?

Inventory count

boolean

Whether variant is archived

string[]

List of fields that changed

PRODUCT_VARIANT_DELETED

Variant removed from a product.

object

Show properties

string

Unique variant identifier

string

Parent product identifier

Product prices

PRODUCT_PRICE_CREATED

Price tier added to a variant.

object

Show properties

string

Unique price identifier

string

Parent variant identifier

string?

Price name (e.g., Monthly)

object

Price details ({amount, type})

string

Currency code

string?

Billing interval (e.g., month)

string?

Trial period (e.g., 14d)

boolean

Whether this is the default price

PRODUCT_PRICE_UPDATED

Price tier changed.

object

Show properties

string

Unique price identifier

string

Parent variant identifier

string?

Price name

object

Price details

string

Currency code

string?

Billing interval

string?

Trial period

boolean

Whether this is the default price

string[]

List of fields that changed

PRODUCT_PRICE_DELETED

Price tier removed.

object

Show properties

string

Unique price identifier

string

Parent variant identifier

Product media

PRODUCT_MEDIA_ADDED

Media files attached to a variant.

object

Show properties

string

Variant identifier

string[]

List of added media identifiers

PRODUCT_MEDIA_REMOVED

Media files removed from a variant.

object

Show properties

string

Variant identifier

string[]

List of removed media identifiers

Product deliverables

PRODUCT_DELIVERABLE_CREATED

New deliverable created.

object

Show properties

string

Unique deliverable identifier

string

Deliverable type (e.g., digital_download)

string

Deliverable name

object?

Type-specific configuration

PRODUCT_DELIVERABLE_UPDATED

Deliverable details changed.

object

Show properties

string

Unique deliverable identifier

string

Deliverable type

string

Deliverable name

object?

Type-specific configuration

string[]

List of fields that changed

PRODUCT_DELIVERABLE_ARCHIVED

Deliverable archived.

object

Show properties

string

Unique deliverable identifier

Product variant deliverables

PRODUCT_VARIANT_DELIVERABLE_ADDED

Deliverable attached to a variant.

object

Show properties

string

Variant identifier

string

Deliverable identifier

PRODUCT_VARIANT_DELIVERABLE_REMOVED

Deliverable removed from a variant.

object

Show properties

string

Variant identifier

string

Deliverable identifier

Shared types

object

Show properties

string

Unique customer identifier

string

Customer email address

string

First name

string

Last name

object

Show properties

string

Unique line item identifier

string

Product name

string

Product SKU

number

Unit price

integer

Quantity ordered

string

Product category

Get started

Platform

Agents

Automations

Storefront

Dev Tools

Orders

Customers

Invoices

Payments

Products

Product variants

Product prices

Product media

Product deliverables

Product variant deliverables

Shared types

​Orders

​Customers

​Invoices

​Payments

​Products

​Product variants

​Product prices

​Product media

​Product deliverables

​Product variant deliverables

​Shared types

Orders

Customers

Invoices

Payments

Products

Product variants

Product prices

Product media

Product deliverables

Product variant deliverables

Shared types