Back to Vibes

Getting Started

Step-by-step guide to creating your first Vibe, understanding YAML structure, and building effective workflow automation from scratch with practical examples and best practices.

Table of Contents

Before you begin working with Vibes, ensure you have the necessary access and setup completed.

Access Requirements

  • Active Platform account with Vibes access
  • Access to the Vibes feature within your organization
  • At least one ChatBot configured in your environment

Accessing the Vibes Feature

To access Vibes within the Platform and begin creating your first workflow:

Access Steps:

  1. Log into your account
  2. Navigate to the Productivity Tab in the Dashboard
  3. Select the Vibes App

Vibes Application Overview

Vibes

Manage your workflow definitions and create new automation

Resources

Configure database and system connections with security controls

Listeners

Set up email listeners for triggering vibes automatically

Logs

Monitor workflow execution history and troubleshoot issues

Scheduled Tab

View and manage your scheduled operations in a comprehensive list with execution tracking and performance monitoring.

AI Assistants

Enable Vibes on your ChatBots for conversational triggering

Creating Your First Vibe

Let's walk through creating a simple Vibe that tells jokes on specific topics. This example will introduce you to the basic structure and workflow creation process.

Step 1: Starting a New Vibe

  1. In the Vibes dashboard, click the 'Add Vibe' button
  2. You'll be presented with a two-step creation process: Add YAML Content, then Configure Details

Step 2: Adding YAML Content

In the YAML content area, enter your workflow definition. Here's a complete example that demonstrates key concepts:

Example: Joke Teller Workflow

Step 3: Configuring Vibe Details

After adding your YAML content, proceed to configure the Vibe details:

Name: Joke Teller

This is the human-readable name displayed in your Vibes list. Should be descriptive and easy to understand.

Slug: joke-teller

Must be unique across your organization. Use lowercase letters, numbers, and hyphens only. No spaces or special characters allowed.

Description

This description is crucial for AI triggering. Write it as if explaining to the AI when this Vibe should activate. Be specific about the Vibe's purpose and use cases.

Authorized Teams and Users

Leave blank to make the Vibe available to anyone with ChatBot access. Add specific teams or users to restrict access.

Step 4: Saving Your Vibe

  • • Review your YAML syntax for any errors
  • • Ensure all required fields are completed
  • • Click 'Save' to create your Vibe

Understanding YAML Structure

YAML (Yet Another Markup Language) is a human-readable data format that Vibes uses to define workflows. Here are the essential concepts you need to know:

Basic YAML Syntax Rules

Indentation Matters

Consistent indentation defines structure

Use spaces, not tabs
Consistent indentation defines structure
Each level of nesting requires 2 additional spaces

Key-Value Pairs

Simple key: value format for defining properties

key: value
name: "Joke Teller"
required: true

Lists and Arrays

Use dashes to define lists of items

steps:
- id: first_step
- id: second_step

Vibe-Specific YAML Structure

Every Vibe follows this basic structure with workflow metadata and steps:

Basic Vibe Structure

YAML Best Practices for Vibes

  • • Use descriptive step IDs: Choose names that clearly indicate what each step does
  • • Add comments when needed: Use # to add explanatory comments
  • • Keep proper indentation: Validate your YAML structure before saving
  • • Quote string values: Use quotes around text values to avoid parsing issues
  • • Test incrementally: Start with simple workflows and add complexity gradually

Vibe Components

Understanding the fundamental components of Vibes is essential for creating effective, reliable workflows. Every Vibe consists of three essential identifying components that determine how it functions and when it gets triggered.

Name Component

The Name is the human-readable identifier for your Vibe that appears throughout the platform interface. This is what you and your team members will see in lists, logs, and management screens.

Best Practices

  • Use clear, descriptive titles that immediately convey the Vibe's purpose
  • Keep names concise but informative (e.g., 'Invoice Processing Workflow' rather than 'Workflow1')
  • Use consistent naming conventions across your organization
  • Avoid technical jargon that non-technical users might not understand

Examples

"Invoice Processing Workflow"
"Passport Expiration Alert"
"Customer Onboarding Process"

Slug Component

The Slug is a unique, technical identifier used internally by the system to reference your Vibe. It must be unique across your entire organization and follows strict formatting rules.

Best Practices

  • Must be unique across your organization
  • Use only lowercase letters, numbers, and hyphens
  • No spaces, special characters, or uppercase letters
  • Should be descriptive but concise

Examples

passport-expire-alert
invoice-processing-v2
customer-onboarding

Description Component

The Description is arguably the most critical component for Vibe functionality. This field enables the AI to determine when to trigger the Vibe during conversations through semantic matching.

Best Practices

  • Write from the AI's perspective, describing when the Vibe should activate
  • Include specific keywords and phrases users might say
  • Mention the types of inputs or files the Vibe expects
  • Describe the end result or outcome users can expect

Examples

Takes an image attachment of a passport, extracts the expiration date, and sets up a scheduled email alert to be sent 1-month before expiration.
Takes an XLSX file containing a Bill of Materials (BOM), extracts the required inventory list, queries current stock levels, and identifies missing items.

Validation and Testing

Before Saving Your Vibe

  • • All required fields are present
  • • Indentation is consistent throughout
  • • Step IDs are unique within the workflow
  • • Function names match available Vibe functions
  • • Variable references use correct syntax

Testing Your Vibe

  • • Attach the Vibe to a ChatBot for testing
  • • Test with various trigger conversations and phrases
  • • Monitor the Logs tab to see execution details
  • • Verify that outputs match your expectations
  • • Refine the description based on triggering accuracy

Testing Tip: Start with simple test cases and gradually try more complex scenarios. Use the Logs feature to understand exactly how your Vibe is processing inputs and generating outputs.

Congratulations on Creating Your First Vibe!

Your YAML structure is the foundation of your Vibe's functionality. Now you're ready to explore more advanced concepts and build more sophisticated workflows.

Explore More ExamplesLearn Core ConceptsSetup Integrations