Introduction

Docebo Connect is a Docebo module acting as a connector between your platform and third-party SaaS systems, helping you to integrate your platform with more than 400 third-party external systems, reducing the integration effort.

Docebo Connect offers a large catalog of connectors for the most popular SaaS systems, to manage automated workflows (called recipes) shared among systems in order to exchange and share data on the basis of triggers.

Please note that Docebo Connect takes advantage of the APIs and business logic already existing in the integrating systems and does not create new ones. In addition, Docebo Connect does not manage SSO flows with Identity Providers (such as SAML, OpenID Connect, etc), JavaScript integrations (such as Google Analytics or Google Tag Manager) or iframe integrations (such as Docebo OEM or Salesforce Canvas).

Glossary

• Recipe: Recipes are automated workflows built by users that can span multiple apps.
• Connection: Docebo Connect needs to be authorized to communicate with other 3rd party solutions, using the app's API, and it may require OAuth-based authorization, API keys, etc; this authorization is referred to as a connection.
• Connector: Allows Docebo Connect to interact with other 3rd party applications through a series of triggers and actions. Connector types:
  • Global-Scope / Prebuilt: Off-the-shelf Connectors ready to use, developed and maintained by either Docebo or Workato.
  • Community Connector: If a Global-Scope / Prebuilt connector is not available for your integration project, with Docebo Connect you can access the Community Library where you can choose from hundreds of connectors developed and maintained by the Workato network partner.
  • SDK Connector: If the connector you need is not available in Docebo Connect as not as Global-Scope / Prebuilt or from the Community Library, you can create your own custom connector. Please note: to do so requires some knowledge of Ruby.
• Triggers: monitor events that occur in the application you hope to connect to and kickstart a workflow of actions that we call recipes (e.g. Webhooks).
• Actions: carry out specific predefined operations in the target application (e.g. API).
• Lookup Table: Lookup tables (similar to cross-reference tables) let you lookup frequently used data easily in a recipe. Data in lookup tables is typically organized like in a database table, with columns and rows of data. You can find an entry within the specified lookup table by matching against data in one or more columns.
• Properties: Account properties allow you to store account-wide recipe configuration parameters. They show up in all recipes as usable values under the Properties data-tree.

Activating Docebo Connect

To activate Docebo Connect on your platform, please reach out to your Docebo Account Manager.

Managing Docebo Connect

Once Docebo Connect is activated in your platform, log in as a Superadmin, access your Admin Menu from the gear icon, find the Docebo Connect section and press Manage.

Project

When you first open Docebo Connect you will land in the Project tab. From here it is possible to:

• Create, test, modify and delete your own recipes.
  Please note: When testing your recipes only the recipe/workflow is in test mode, meaning that the related API calls are made for real and, as a consequence, the create, update or delete action that is invoked by that action will actually affect the resource on Docebo or the 3rd party platform.
• Add, remove, start and stop Pre-Built Connectors to applications. Connectors are a basic requirement for each system you wish to integrate with the Docebo platform, they provide the connection upon which recipes are built. Find out more about Connectors in the Workato Knowledge Base.
  Please Note: the Docebo Learn connection (named docebo_connector_connection_internal) must not be moved, renamed or deleted - it must be left as is. Deleting this connection will require you to contact support in order to restore the functionality.
• The system has a built-in trash bin system, meaning that in the case of unintended recipe or connector deletion those items can easily be recovered until they are manually permanently deleted from the system.
• There is also the recipe versioning system which makes it possible to restore any previous recipe version.
• Start, stop and restart the execution of the recipes and, in case it is necessary, debug the recipes.
• Organize your recipes in folders and subfolders according to your organizational needs.

This tab lists all of the recipes and connections already configured in your platform. Recipes are automated workflows that can make multiple apps interact. Each recipe is made up of a trigger and one or more actions that are carried out when a trigger occurs. Find out more.

If you are accessing Docebo Connect for the first time, there will be no recipes configured except for a recipe called Examples, which is created automatically for integration purposes. You can keep that recipe as an example for the creation of other recipes, or rename it.

Before using the recipes contained in the Example folder, it is necessary to clone the originals. This creates a copy of the recipe that is linked to the original recipe which is maintained and automatically updated by Docebo. When a recipe is updated you will be given the opportunity to update the cloned recipe as well. This process insulates your recipes from being automatically overwritten by any updates, potentially erasing any customizations you may have performed and / or blocking of recipes linked to additions or automation in production.

In order to clone a recipe, press the ellipsis button in the recipe and choose Clone recipe.

Once the recipe has been successfully cloned, Docebo Connect will automatically open the newly cloned recipe for editing purposes so you can, for example, rename it.

Once the recipe has been cloned, it is considered best practice to move the cloned recipe into a separate folder that will contain all the related and also cloned recipes of the integration.

In addition to that, it is possible to find a vast collection of recipe examples in the Community Library tab which is provided for and maintained by the Workato community.

Find out more on how to create recipes in the Workato Knowledge Base.

Dashboard

In the Dashboard tab you can monitor the jobs created by your recipes. In this tab, you can find the details into the execution flow of a job, i.e. what steps were executed, and the data input and output from every step. More details on job monitoring.

This page is divided into three sections:

• Dashboard: Where it is possible to monitor the progress of jobs (number of executions, status) for a specific period of time (e.g. 7 days) and drill down on the single job report. Find out more in the Workato Knowledge Base.
• Dependency Graph: it’s a tool that visually illustrates the relationships between every asset and resource (e.g. recipes). Find out more in the Workato Knowledge Base.
• Activity Audit Log: Activity audit provides a simple and powerful interface for administrators to comprehensively track changes to the account, connections, recipes, folders and packages. Find out more in the Workato Knowledge Base.

Connector SDK

From the Connector SDK tab, it is possible to create, update or delete your own custom connector and manage the connectors imported from the community.

These connectors have a private scope by default which means that they are only visible and available to the connector owner. After the connector is built and released, you have the ability to use it in your recipes.

Find out more on Connector SDK in the Workato Knowledge Base.

Lookup Table

From the Lookup Table tab is possible to manage your own lookup table(s), defining a new table, creating, updating, and deleting lookup table entries, and massive import data via CSV.

Find out more on Lookup tables in the Workato Knowledge Base.

Properties

In the Properties tab it is possible to create, update and delete your own Account properties.

Find out more on Account properties in the Workato Knowledge Base.

Community Library

The Community Library is a great place to explore when first using Docebo Connect. There you can find many example recipes as well as connectors developed, maintained and contributed by the Workato community.

In the recipe section within the Community Library tab you can browse example recipes by category (e.g. Collaboration, HR, Utility, etc) and/or leveraging the text search functionality.

Once you have identified the community recipe you are interested in, by clicking on Use this recipe, the community recipe is imported in Docebo Connect:

From there you can start customizing to your needs (Please note: Docebo Connect requires you to use the Docebo Learn Connector in your recipes):

In the Custom Connectors section, you can find a large collection of connectors developed and maintained by the Workato community. Just as it is for recipes, it is possible to browse available connectors by category (e.g. Collaboration, HR, Utility, etc) and/or leveraging the text search function.

Once you have identified the connector that fits your needs you can import it into your Docebo Connect account by clicking on the Install connector button:

Click Accept and install to complete the install procedure:

The connector the becomes available under the Connector SDK tab:

In order to use the imported connector in your recipes, you have to release it to your Docebo Connect account by clicking on the Release latest version button:

Find out more on Community connectors via the Workato Knowledgebase.

API Platform

With Docebo Connect you are able to expose recipes as custom API endpoints. This allows you to extend the functionality of the existing Docebo API platform to suit your needs. Please see the Workato Knowledgebase for further details.

The API Platform Tab is broken down into the following views:

Dashboard Tab

When you first access the API platform in Docebo Connect you will be on the Dashboard tab. In this tab you are presented with an overview of your Docebo Connect API usage. Please see the Workato Knowledgebase for further details.

API Collections Tab

In the API Collections tab you see groups of endpoints that you can create. Please note the Provisioning collection, if present, should not be deleted. Please see the Workato Knowledgebase for further details on how to create collections.

Policies Tab

Policies allow for control over API usage. For example, you can restrict usage of an API to limit the number of times it is called in order to prevent degraded performance. Setting a policy is optional however, not setting access policies allows for unrestricted usage. Please see the Workato Knowledgebase for further details on how to create policies.

Clients Tab

Clients are groups of users with access to API collections through their access profile. Clients can have multiple access profiles. Please see the Workato Knowledgebase for further details on creating and managing clients.

Logs Tab

This view shows a detailed list of all the connection activity within your API platform. 

Library Tab

The Library is a list of API collections that are discoverable by other users in your organization. Users can find documentation, examples, and tools that they need to use your API here. Please see the Workato Knowledgebase for further information on all the features found in your API Collection Library.

Settings Tab

In this tab you are able to configure the API Prefix and set a custom Domain.

API Prefix

You can customize the prefix in the URL for all of your endpoints here, please see the Workato Knowledgebase for further information on how to customize your prefix.

Custom Domain

You can use a custom domain to redirect to your API endpoints, please see the Workato Knowledgebase for further information on how to use your own custom domain.

Message Templates

Message templates allow you to prepare static templates for frequently used messages utilizing Mustache as the templating language. These templates can be used to generate messages in various formats, such as XML, JSON, HTML or text. 

Message Templates enable the template developer to change the format of the message, by separating the generation from the composition logic, without making changes to the recipe that sends the message out.

For more information please see the Workato Knowledgebase.

Available Recipe Actions

This is a list of the Docebo actions that you can use in recipes, either as final or intermediate steps. The actions, as listed here, are intended as general guidelines. Every action includes a set of parameters (such as, username, course ID, etc).

• Add course to learning plan - Add course to learning plan in Docebo
• Batch update rsvp event - Batch update rsvp event in Docebo
• Custom action - Build your own Docebo action with a custom request
• Create course - Create course in Docebo
• Create event - Create event in Docebo
• Create learning plan - Create learning plan in Docebo
• Create session - Create session in Docebo
• Create user - Create user in Docebo
• Delete course - Delete course in Docebo
• Delete event - Delete event in Docebo
• Delete learning plan - Delete learning plan in Docebo
• Delete session - Delete session in Docebo
• Delete user - Delete user in Docebo
• Delete users - Delete users in Docebo
• Duplicate session - Duplicate session in Docebo
• Enroll user into a course - Enroll user into a course in Docebo
• Enroll user into a session - Enroll user into a session in Docebo
• Get course by ID - Get course by ID in Docebo
• Get courses - Get all courses in Docebo
• Get enrollments - Get enrollments in Docebo
• Get enrollments by session ID - Get enrollments by session ID in Docebo
• Get event by ID - Get event by ID in Docebo
• Get events by session ID - Get events by session ID in Docebo
• Get ilt sessions - Get ILT sessions in Docebo
• Get learning plan by ID - Get learning plan by ID in Docebo
• Get learning plans - Get learning plans in Docebo
• Get session by ID - Get session by ID in Docebo
• Get sessions by course ID - Get sessions by course ID in Docebo
• Get user by ID - Get user by ID in Docebo
• Get users - Get users in Docebo
• Remove course from learning plan - Remove course from learning plan in Docebo
• Share file - Share file in Docebo
• Share link - Share link in Docebo
• Test authentication - Test authentication in Docebo
• Unenroll user from course - Unenroll user from course in Docebo
• Unenroll user from learning plan - Unenroll user from learning plan in Docebo
• Unenroll user from session - Unenroll user from session in Docebo
• Update course - Update course in Docebo
• Update event - Update event in Docebo
• Update learning plan - Update learning plan in Docebo
• Update session - Update session in Docebo
• Update user - Update user in Docebo