Learning PathModule

Deploy and build Connectors

Build an order confirmation Connector from the official email template, publish it privately, then install and operate it as a Client.

Build with AI: The commercetools AI plugin and its commercetools-connect skill speed up Connector development, but AI models can make mistakes. This module teaches you the knowledge to critically evaluate solutions and identify generated errors.

AI assistance does not transfer accountability; you remain responsible for all production code. Review, test, and verify AI-generated output to the same standard as manual code.

Learning objectives

After completing this module, you should be able to:

  • Start a Connector from an official template, and modernize its credentials and dependencies.
  • Explain a Connector's connect.yaml: applications, endpoints, configuration, scopes, and lifecycle scripts.
  • Narrow an event application to the Message types it sends for, state its delivery policy and failure mode, and recognize the API Extension contract in a service application's code.
  • Stage, preview, and publish a Connector privately, and explain what the validation pipeline and certification check.
  • Install a Connector in the correct Region and environment through the Merchant Center, the Connect CLI, or the Connect API, and verify it against the resources it creates.
  • Resolve a change request through configuration and redeployment before changing code, and diagnose a Deployment using logs, reports, and resources.
Agenda

Creator tasks:

  1. Start from the email template
  2. Implement and test the event app to the contract
  3. Stage, preview, and publish privately

Client tasks:

  1. Install and test your Connector
  2. Operate a Deployment

To finish:

  1. Extend it with AI (optional)
  2. Learning check
Prerequisites

Required:

Recommended:

Environment checklist

To complete the hands-on steps, you need the following:

  • A commercetools Project. A trial Project works: you install with the Connect CLI to the sandbox environment. Production Deployments need a Project that isn't a trial, and a first production publish has an extra step. See Production.
  • Membership in your Organization's Administrators Team, if you want to use the Merchant Center's Connect tab.
  • Node.js v22 or v24 (see supported runtimes), and Docker, which the Connect CLI needs.
  • The Connect CLI, @commercetools/cli.
  • A GitHub account for your own copy of the template.
  • An API Client for the CLI with the scopes manage_connectors, manage_connectors_deployments, manage_api_clients, manage_orders, and view_subscriptions or manage_subscriptions. Start from the email template explains what each is for.
  • curl and jq for the Connect API and HTTP API examples.
You don't need an email provider account for these exercises. The Connector's provider call stays stubbed throughout the module, so these steps don't verify actual email delivery. Before a real provider-backed Deployment, check whether the provider requires a commercial contract and assess provider and Deployment costs independently. This module doesn't estimate those costs.
Audience

This module is designed for technical professionals who build, deploy, or operate Connect applications, including:

  • Backend developers
  • Technical team leads
  • Technical solution architects