Skip to main content
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Catalog Release Notes (2025-09-01)

Catalog Release Notes (2025-09-01)

Release notes outline upcoming customer-impacting changes that are expected to be displayed in production environments. Please note that features considered for future development are not included in the notes.

Canvas Catalog is an all-in-one learning solution that integrates with the Canvas LMS as a course registration system, payment gateway, and learning platform. Learn more about Canvas Catalog.

Unless otherwise stated, all features in this release are available in the Production environment on 2025-09-01.

 

New Features

 

Salesforce Integration: Expanded Data Synchronization

Summary

The Salesforce integration is enhanced to synchronize additional fields for enrollment, course progress, and catalog listings. Users can track enrollment timelines, course engagement, and catalog-specific metrics without relying on manual exports.

Change Benefit

These improvements provide richer reporting and deeper insights directly within Salesforce. This expanded data synchronization streamlines reporting, supports more informed decision-making, and aligns with user requests for broader visibility into course and catalog activity.

Workflow

View Mapping InformationView Mapping Information

 To configure the Salesforce integration, navigate to the Mapping tab in the admin dashboard [1].

Use the field mapping interface to connect additional data fields to Salesforce [2]. Click the Save button [3].

After the fields are mapped, they synchronize automatically alongside existing user data such as first name, last name, and email.

With the expanded dataset in Salesforce, administrators can build dashboards and reports that track enrollment activity, measure course engagement, and evaluate catalog performance.

 

Supported Objects

users

Description: User accounts with custom field support


Note: This entity includes dynamically-added User Defined Fields (UDFs) configured per account.


Field Name

Data Type

Description

id

bigint

Primary key

first_name

character varying

User's first name

last_name

character varying

User's last name

user_name

character varying

Username

email_address

character varying

Email address

canvas_root_account_uuid

character varying

Canvas root account UUID

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

custom_fields

varies

Dynamically added based on account's User Defined Fields configuration


account_admins

Description: Catalog account administrators


Field Name

Data Type

Description

id

bigint

Primary key

canvas_user_id

bigint

Canvas user identifier

account_id

bigint

Account identifier (FK to accounts)

name

character varying

Admin name

email

character varying

Admin email address

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

root_account_id

bigint

Root account identifier

canvas_root_account_uuid

character varying

Canvas root account UUID

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


accounts

Description: Catalog accounts (organizational hierarchy)


Field Name

Data Type

Description

id

bigint

Primary key

parent_id

bigint

Parent account identifier

name

character varying

Account name

about

text

Account description

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

portal_path

character varying

Portal URL path

canvas_domain

character varying

Canvas domain

type

character varying

Account type

settings

jsonb

Account settings (JSON)

canvas_id

bigint

Canvas account ID

locale

character varying

Locale setting

text_overrides

jsonb

Custom text overrides (JSON)

deleted_at

timestamp without time zone

Soft deletion timestamp

logo_file_name

character varying

Logo file name

logo_content_type

character varying

Logo MIME type

logo_file_size

bigint

Logo file size in bytes

logo_updated_at

timestamp without time zone

Logo update timestamp

favicon_file_name

character varying

Favicon file name

favicon_content_type

character varying

Favicon MIME type

favicon_file_size

bigint

Favicon file size in bytes

favicon_updated_at

timestamp without time zone

Favicon update timestamp

header_image_file_name

character varying

Header image file name

header_image_content_type

character varying

Header image MIME type

header_image_file_size

bigint

Header image file size in bytes

header_image_updated_at

timestamp without time zone

Header image update timestamp

canvas_account_uuid

character varying

Canvas account UUID

canvas_root_account_uuid

character varying

Canvas root account UUID

alias_path

character varying

Alias URL path

committed_at

timestamp without time zone

Transaction commit timestamp


applicants

Description: Users who have applied to waitlisted products


Field Name

Data Type

Description

id

bigint

Primary key

product_id

bigint

Product identifier (FK to products)

name

character varying

Applicant name

email

character varying

Applicant email

canvas_user_id

bigint

Canvas user identifier

notified_of_opening_at

timestamp without time zone

Notification timestamp

status

character varying

Application status

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

token

character varying

Authentication token

activated

boolean

Activation status

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


bulk_checkout_promotions

Description: Promotions applied to bulk checkouts


Field Name

Data Type

Description

id

bigint

Primary key

bulk_checkout_id

bigint

Bulk checkout identifier (FK to bulk_checkouts)

promotion_id

bigint

Promotion identifier (FK to promotions)

discount

decimal

Discount amount applied

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


bulk_checkouts

Description: Bulk enrollment purchases


Field Name

Data Type

Description

id

bigint

Primary key

canvas_user_id

bigint

Purchaser's Canvas user identifier

product_id

bigint

Product identifier (FK to products)

account_id

bigint

Account identifier (FK to accounts)

order_id

bigint

Order identifier (FK to orders)

seats

integer

Number of seats purchased

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

checkout_time

timestamp without time zone

Purchase completion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


bulk_invitations

Description: Invitation codes for bulk enrollment seats


Field Name

Data Type

Description

id

bigint

Primary key

order_item_id

bigint

Order item identifier (FK to order_items)

product_id

bigint

Product identifier (FK to products)

email

character varying

Invitee email address

code

character varying

Invitation code

status

character varying

Invitation status (pending/accepted/revoked)

invited_at

timestamp without time zone

Invitation sent timestamp

revoked_at

timestamp without time zone

Revocation timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

enrollment_id

bigint

Enrollment identifier (FK to enrollments)

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


cart_item_promotions

Description: Promotions applied to shopping cart items


Field Name

Data Type

Description

id

bigint

Primary key

cart_item_id

bigint

Cart item identifier (FK to cart_items)

promotion_id

bigint

Promotion identifier (FK to promotions)

discount

decimal

Discount amount applied

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


cart_items

Description: Items in shopping carts


Field Name

Data Type

Description

id

bigint

Primary key

cart_id

bigint

Cart identifier (FK to carts)

product_id

bigint

Product identifier (FK to products)

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


carts

Description: User shopping carts


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

canvas_user_id

bigint

User's Canvas identifier

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

order_id

bigint

Converted order identifier (FK to orders)

checkout_time

timestamp without time zone

Checkout completion timestamp

root_account_id

bigint

Root account identifier

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


categories

Description: Product categorization


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

group_id

bigint

Group identifier

group_type

character varying

Group type

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


certificate_templates

Description: Certificate template definitions


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

name

character varying

Template name

template

text

Template HTML content

pdf_settings

jsonb

PDF generation settings (JSON)

code

character varying

Template code

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


certificates

Description: Product completion certificates


Field Name

Data Type

Description

id

bigint

Primary key

product_id

bigint

Product identifier (FK to products)

name

character varying

Certificate name

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

old_template

text

Legacy template content

old_pdf_settings

jsonb

Legacy PDF settings (JSON)

deleted_at

timestamp without time zone

Soft deletion timestamp

certificate_template_id

bigint

Template identifier (FK to certificate_templates)

active

boolean

Active status

custom_template_id

bigint

Custom template identifier

days_to_expire

integer

Expiration period in days

expires_at

timestamp without time zone

Expiration timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


custom_emails

Description: Custom email template configurations


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

email_type

character varying

Email type/trigger

draft

jsonb

Draft email content (JSON)

published

jsonb

Published email content (JSON)

canvas_root_account_uuid

character varying

Canvas root account UUID

created_at

timestamp without time zone

Record creation timestamp

created_by

bigint

Creator user identifier

updated_at

timestamp without time zone

Record update timestamp

updated_by

bigint

Last updater user identifier

published_at

timestamp without time zone

Publication timestamp

published_by

bigint

Publisher user identifier

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


email_layouts

Description: Email header and footer layouts


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

header

text

Email header HTML

footer

text

Email footer HTML

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


enrollments

Description: User enrollments in products


Field Name

Data Type

Description

id

bigint

Primary key

canvas_user_id

bigint

User's Canvas identifier

product_id

bigint

Product identifier (FK to products)

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

root_program_id

bigint

Root program identifier (for nested programs)

requirements_completed_at

timestamp without time zone

Completion timestamp

ends_at

timestamp without time zone

Enrollment end timestamp

external_id

character varying

External system identifier

status

character varying

Enrollment status

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

last_sync_error

text

Last synchronization error message

order_item_id

bigint

Order item identifier (FK to order_items)

committed_at

timestamp without time zone

Transaction commit timestamp


order_item_promotions

Description: Promotions applied to order items


Field Name

Data Type

Description

id

bigint

Primary key

order_item_id

bigint

Order item identifier (FK to order_items)

promotion_id

bigint

Promotion identifier (FK to promotions)

discount

decimal

Discount amount applied

deleted_at

timestamp without time zone

Soft deletion timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


order_items

Description: Line items within orders


Field Name

Data Type

Description

id

bigint

Primary key

order_id

bigint

Order identifier (FK to orders)

item_id

bigint

Product identifier (FK to products)

amount

decimal

Line item total amount

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

discounted_amount

decimal

Amount after discounts

quantity

integer

Quantity purchased

unit_price

decimal

Price per unit

committed_at

timestamp without time zone

Transaction commit timestamp


orders

Description: Purchase orders


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

canvas_user_id

bigint

Purchaser's Canvas identifier

email

character varying

Purchaser email

name

character varying

Purchaser name

total

decimal

Order total amount

currency

character varying

Currency code (e.g., USD)

purchased_at

timestamp without time zone

Purchase timestamp

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

full_id

character varying

Human-readable order ID

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

source

character varying

Order source (cart/bulk)

user_id

bigint

User identifier

committed_at

timestamp without time zone

Transaction commit timestamp


payments

Description: Payment transactions for orders


Field Name

Data Type

Description

id

bigint

Primary key

order_id

bigint

Order identifier (FK to orders)

reference_id

character varying

Payment gateway reference ID

amount

decimal

Payment amount

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

status

character varying

Payment status

purchase_params

jsonb

Payment parameters (JSON)

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


product_images

Description: Product image attachments


Field Name

Data Type

Description

id

bigint

Primary key

product_id

bigint

Product identifier (FK to products)

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

image_file_name

character varying

Image file name

image_content_type

character varying

Image MIME type

image_file_size

bigint

Image file size in bytes

image_updated_at

timestamp without time zone

Image update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


product_pathways

Description: Product pathway (badge/credential) associations


Field Name

Data Type

Description

id

bigint

Primary key

product_id

bigint

Product identifier (FK to products)

name

character varying

Pathway name

public_url

character varying

Public pathway URL

canvas_root_account_uuid

character varying

Canvas root account UUID

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp

external_id

character varying

External pathway identifier


product_tags

Description: Tag associations for products


Field Name

Data Type

Description

id

bigint

Primary key

product_id

bigint

Product identifier (FK to products)

tag_id

bigint

Tag identifier (FK to tags)

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


products

Description: Courses and programs available in the catalog


Field Name

Data Type

Description

id

bigint

Primary key

visibility

character varying

Visibility setting (public/private/hidden)

enrollment_open

boolean

Whether enrollment is open

title

character varying

Product title

start_date

date

Product start date

end_date

date

Product end date

description

text

Product description

enrollment_fee

decimal

Enrollment fee amount

canvas_course_id

bigint

Canvas course identifier

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

path

character varying

URL path

account_id

bigint

Account identifier (FK to accounts)

list_order

integer

Display order

type

character varying

Product type (Course/Program)

teaser

text

Short description/teaser

owner_id

bigint

Owner user identifier

canvas_section_id

bigint

Canvas section identifier

sequential

boolean

Whether requirements are sequential

days_to_complete

integer

Completion deadline in days

deleted_at

timestamp without time zone

Soft deletion timestamp

enrollment_cap

integer

Maximum enrollment capacity

waitlist

boolean

Whether waitlist is enabled

credits

character varying

Credit hours/units

waitlist_cap

integer

Maximum waitlist capacity

sku

character varying

Stock keeping unit (SKU)

show_free_banner

boolean

Display "free" indicator

image_alt_text

character varying

Image accessibility text

external_redirect_url

character varying

External redirect URL

allowed_payment_types

character varying

Allowed payment methods

canvas_root_account_uuid

character varying

Canvas root account UUID

workflow_state

character varying

Workflow state

workflow_state_timestamp

timestamp without time zone

Workflow state change timestamp

detail_code

character varying

Product detail code

bulk_purchase_disabled

boolean

Whether bulk purchase is disabled

enrollment_open_from

timestamp without time zone

Enrollment opening timestamp

enrollment_open_to

timestamp without time zone

Enrollment closing timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


program_requirements

Description: Course requirements within programs


Field Name

Data Type

Description

id

bigint

Primary key

program_id

bigint

Program identifier (FK to products)

product_id

bigint

Required product identifier (FK to products)

sequence

integer

Requirement sequence order

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


promotions

Description: Promotional codes and discounts


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

product_id

bigint

Product identifier (FK to products) - null for account-wide

amount

decimal

Discount amount or percentage

discount_type

character varying

Discount type (percentage/fixed)

code

character varying

Promotion code

name

character varying

Promotion name

description

text

Promotion description

active

boolean

Active status

start_date

date

Promotion start date

end_date

date

Promotion end date

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

deleted_at

timestamp without time zone

Soft deletion timestamp

usage_type

character varying

Usage type (single/multiple)

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


tags

Description: Tags for product categorization


Field Name

Data Type

Description

id

bigint

Primary key

account_id

bigint

Account identifier (FK to accounts)

name

character varying

Tag name

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

deleted_at

timestamp without time zone

Soft deletion timestamp

committed_at

timestamp without time zone

Transaction commit timestamp


themes

Description: Custom CSS and JavaScript themes


Field Name

Data Type

Description

id

bigint

Primary key

name

character varying

Theme name

css_content

text

CSS stylesheet content

themeable_type

character varying

Themeable entity type

themeable_id

bigint

Themeable entity identifier

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

js_content

text

JavaScript content

deleted_at

timestamp without time zone

Soft deletion timestamp

js_file_name

character varying

JavaScript file name

js_content_type

character varying

JavaScript MIME type

js_file_size

bigint

JavaScript file size in bytes

js_updated_at

timestamp without time zone

JavaScript update timestamp

css_file_name

character varying

CSS file name

css_content_type

character varying

CSS MIME type

css_file_size

bigint

CSS file size in bytes

css_updated_at

timestamp without time zone

CSS update timestamp

canvas_root_account_uuid

character varying

Canvas root account UUID

committed_at

timestamp without time zone

Transaction commit timestamp


user_defined_fields

Description: Custom field definitions for user profiles


Field Name

Data Type

Description

id

bigint

Primary key

name

character varying

Internal field name

label

character varying

Display label

field_type

character varying

Field type (text/select/checkbox/etc.)

required

boolean

Whether field is required

required_message

character varying

Validation error message

account_id

bigint

Account identifier (FK to accounts)

created_at

timestamp without time zone

Record creation timestamp

updated_at

timestamp without time zone

Record update timestamp

list_order

integer

Display order

canvas_root_account_uuid

character varying

Canvas root account UUID

deleted_at

timestamp without time zone

Soft deletion timestamp

hide_in_user_workflow

boolean

Whether to hide in user registration

committed_at

timestamp without time zone

Transaction commit timestamp

 

Change Log

2025-10-15

Updated the Supported Objects tables.

2025-10-15

Published

2025-09-04

Published