Using the SmartThings Console

This reference guide provides step-by-step walkthroughs of common tasks in the SmartThings Console, the web-based tool used to submit and manage Works with SmartThings certification requests. This document will help you:

• Create an organization: Developer Center Organizations allow you to enable other users to help manage your brand and products in the Console.
• Establish a brand: Create the public identity that appears to users in the SmartThings app.
• Configure device onboarding behavior: Define how users pair and troubleshoot your devices.
• Define your products: Input technical specifications and integration details for your specific hardware or cloud connections.
• Submit for certification: Submit certification requests for your configured products.

Organizations

Organizations allow you to enable other individuals to help manage your brand in SmartThings. Joining or creating an organization is optional when using the Console. Members of the same organization will have access to all brands associated with the organization.

Admins and Developers share the same privileges except for those specific to managing the Organization.

Only Admins can view members, invite members, remove members, edit member roles, edit the Organization name, and delete the Organization.

tip

To manage or join an organization, visit https://developer.smartthings.com/console/organization.

Brands

A Brand creates the identity under which users see your devices in the SmartThings app. You must create a Brand before submitting a product for certification.

The brand name and logo you supply when defining your brand in the Console will be displayed to users in the SmartThings app.

tip

Manage your brands at https://developer.smartthings.com/console/brands.

Create a New Brand

1. Sign in to the SmartThings Console with your Samsung Account.
2. Select the Brands section in the left-hand sidebar.
3. Click Add new Brand.
4. Enter your Brand details:
   • Brand name: Enter the unique name for your brand.
   • Brand URL: Enter the main website URL for this brand.
   • Brand description: Write a short bio (max 500 characters).
   • Brand logo small (app version): Upload a JPG or PNG (min 240x240 px, 1:1 ratio).
   • Brand logo large (web version): Upload a PNG, JPG, or SVG (min 400x400 px, 1:1 ratio).
5. Enter Customer support information:
   • Support email: Enter a valid support email address.
   • Support information: Provide troubleshooting tips and contact details.
6. Enter Company details:
   • Fill in the Company name, Country/region, Address, City, State, and ZIP code.
7. Enter Billing information (if different from company address).
8. Enter a Point of contact:
   • Provide the Contact name, Phone number, and Email address.
9. Confirm you have permission to submit this brand on behalf of the company described by checking ✅ I am an employee or authorized representative of this Brand.
10. Click Create Brand.

Edit a Brand

1. Go to the Brands tab.
2. Click the overflow menu (three dots) icon next to your Brand name.
3. Select Edit Brand.
4. Make your changes.
5. Check the authorization box and click Update Brand.

Delete a Brand

1. Go to the Brands tab.
2. Click the overflow menu (three dots) icon next to the Brand you wish to remove.
3. Select Delete Brand.
   • Note: You can only delete Brands not currently used by a Product.
4. In the pop-up window, click Remove Brand to confirm.

Products

The Products section is your central hub for configuring devices and integrations before certification.

Add a New Product

tip

Save your progress as you go and return anytime to fill in sections in any order.

1. Sign in to the SmartThings Console.
2. Select the Device Integrations section in the left-hand sidebar.
3. Click Create.
4. Select your product's integration protocol.
5. You will be taken to the new product creation page to define several aspects of your device, including:
   1. Product Details
   2. Brand
   3. Integration Details
   4. Setup & Support Profiles
   5. (Optional) Test Suite Results

Define Product Details

These details appear to the user in the SmartThings app.

1. Product name:: Your product name.
2. Model number:: Enter the exact model number (must match the device shipped for testing).
3. Product category:: Select the relevant categories for your device.
4. Product description:: Describe your product.
5. Product Image: Upload a transparent PNG (min 584x584 px).
6. Distribution regions: The regions your product is available in.
7. Product Purchase Link: The default purchase URL to purchase your product. Regional purchase links can also be added.

Associate Your Product With a Brand

Select a brand for your product. Choose from the brands associated with your account, or create a new brand for your product.

Define Integration Details

These fields are based on your integration protocol type.

Hub Connected Devices (Matter | Zigbee | Z-Wave)

Hub Connected Devices use SmartThings Edge Drivers to communicate with the SmartThings platform. SmartThings offers a wide range of standard, pre-built Edge drivers for you to choose from. Selecting a standard Edge driver is the quickest way to bring your product to the platform.

Need help finding a driver? The Console provides an interactive UI for finding a driver when beginning the Integration Details process. Just click Find an Edge Driver on the Integration Details screen to launch the Edge Driver Builder.

1. Choose Standard (recommended) to select a predefined Edge driver, or Custom for custom drivers (requires custom code and approval from SmartThings).
2. Depending on the protocol selected when creating your product, fill in the required fields:
   • Matter: Vendor ID (VID), Product ID (PID).
   • Zigbee: Manufacturer name, Model Identifier.
   • Z-Wave: Manufacturer ID, Product Type, Product ID.
3. Driver: Select the appropriate Edge driver for your product. If using the Edge Driver Builder, a driver based on your device capabilities will be suggested for you.
4. Device Profile: Choose a device profile that matches your configuration. If using the Edge Driver Builder, a Device Profile based on your device capabilities will be suggested for you.

For Hub Connected Devices, you will also need to define a Setup & Support Profile to define the pairing screens and troubleshooting instructions your product displays to users. Visit Setup & Support Profiles to learn more.

Cloud Connected (Schema) Devices

1. Select the hosting solution your Schema App utilizes: AWS Lambda or Webhook Endpoint.
2. Display Name: Select a name to be displayed in the SmartThings app.
3. Target ARN or Target URL: For AWS, enter your applicable-regional (NA, EU, AP) ARNs for your Lambda function. For Webhook Endpoints, enter your secure target URL that can receive incoming JSON payloads from SmartThings using HTTP POST requests.
4. Device Cloud Credentials:
   1. Client ID
   2. Client Secret
   3. OAuth URL
   4. OAuth Scope
   5. Token URL
   6. Alert Notification Email
5. App-to-App Linking (Optional): App-to-App Account Linking allows users to link their account on your platform with their SmartThings account when your app and the SmartThings app are installed on the user's mobile device. Visit the App-to-App Linking documentation to learn more.
   1. Android App-to-App Link
   2. iOS App-to-App Link

You will also need to select a Device Profile or Device Handler Type to define your product's capabilities. SmartThings offers several pre-made Device Handler Types to fit a wide range of product capabilities, seamlessly handling your device's presentation and functionality in the SmartThings app. Find a complete list of Device Handler Types, visit the Device Handler Types Reference

If your product's capabilities are not fully captured in a pre-made Device Handler Type, you will need to create a custom Device Profile. The Console interactive UI will guide you through the creation process.

Direct Connected Devices

Direct Connected Devices must be associated with a Device Profile. Select a Device Profile you have previously created, or create a new one in the interactive Console UI when defining your product integration details.

You will also need to define a Setup & Support Profile to define the pairing screens and troubleshooting instructions your product displays to users. Visit Setup & Support Profiles to learn more.

Setup & Support Profiles

A Setup & Support profile defines the pairing screens and troubleshooting instructions that users are presented when joining your Hub Connected Device to SmartThings.

Create a Setup & Support Profile

1. Sign in to the SmartThings Console.

info

If you have no existing profiles, you must start by creating a Product. Click Create Product and select your integration type. As part of the Product creation process, you will have the opportunity to create a new Setup & Support profile.

1. If you have an existing Setup & Support profile: Navigate to the Device Integrations sidebar menu.
2. Select the Setup & Support Profile tab and click Add new Setup & Support Profile.
3. Enter the Profile name: This describes the group of products using this profile (visible to users).
4. Select the Product Type (Matter, Zigbee, or Z-Wave).
5. Provide the following data in English (United States):
   • Profile name: The name users see in the app.
   • Pairing Instructions: Steps for adding the device in the SmartThings app.
   • Troubleshooting Instructions: Steps to resolve connection issues (can include external URLs).
   • Disconnection steps: (Z-Wave only) Instructions for resetting and removing the device.
6. Add translations for other languages if applicable. The Console offers an auto-translate feature to translate your Setup & Support profile instructions into supported languages.
7. Click Create profile.

Edit a Setup & Support Profile

1. Navigate to the Device Integrations sidebar menu of the Console.
2. Go to the Setup & Support Profiles tab.
3. Click the overflow menu (three dots) icon next to the profile.
4. Select Edit Profile.
5. Make your changes and click Update Profile.

Delete a Setup & Support Profile

1. Navigate to the Device Integrations sidebar menu of the Console.
2. Go to the Setup & Support Profile tab.
3. Click the overflow menu (three dots) icon next to the profile.
4. Select Delete Profile.
   • Note: You can only delete profiles not currently associated with a Product.
5. In the pop-up window, click Remove Profile to confirm.

Certifications

Once your product is created, configured, and tested, you are ready to submit for Works with SmartThings (WWST) certification. Please review Apply For Certification to familiarize yourself with the certification requirements and processes.

Submit a Certification Request

1. Navigate to the Device Integrations Console tab.
2. Select a Product.
3. Ensure you have completed all required product information, including product and integration details.
4. Link your Test Suite results.
5. Click Submit For Certification. SmartThings will review your request. You can view your submission status in the Submissions sidebar tab of the Console.

Certification Status

View your Works with SmartThings certification submissions in the Submissions tab of the Console.

Your request will show one of the following states:

• Pending: Currently under review.
• Approved: Successfully certified.
• Rejected: Failed approval.
• Cancelled: Request cancelled by user.

Cancel a Certification Request

1. Go to the Submissions tab.
2. Click the Actions button next to your request.
3. Select Cancel request.
4. Click Confirm.