Skip to main content

Get Started

This page provides the steps needed to create your first extension.

Prerequisite​

Before you begin working with Boltic’s cloud services and APIs, ensure the following requirements are met:

  • Node.js v18 or later
  • You must have a Boltic account to access Boltic's cloud services and APIs.
  • Understanding REST APIs is particularly important for understanding how authentication works (e.g., API keys or OAuth) and how data is manipulated.
  • Comfortable working with form components such as text inputs, number fields, and checkboxes. These are fundamental for designing data fields that accurately process incoming data types. Learn more about integer text widgets for numbers.
  • Access to specific activity-related documentation. For example, if you aim to implement an activity for Freshsales, ensure you have the documentation for the Create Account API. This might include API endpoints, required headers, and example request bodies.
  • If you integrate with external services (e.g., Freshsales), ensure you have the corresponding API documentation on hand. This typically includes:
    • Endpoint URLs
    • Required headers and authentication schemes
    • Sample request/response formats

Install Boltic CLI​

The Boltic CLI simplifies workflow integration development using commands for creating, testing, and deploying projects.

  • Run the following commands to install the Boltic CLI:
npm install -g @boltic/cli

Generate a Boilerplate​

Follow the steps below to generate a boilerplate for your Boltic integration workflows:

  1. Run the following login command:
boltic login
  1. Run the following command to create integration:
boltic integration create
  1. Provide a name for the integration.
  2. Choose an option to create an activity integration. Activity Integrations are reusable components that perform specific tasks in your workflow: - If yes, enter a description for the AI integration. - If no, continue to the next step.
  3. Choose an option to create a trigger integration. Triggers start your workflow based on external events. - If yes, enter a description for AI trigger. - If no, continue to the next step.
note

You must select at least one option as Yes—either Activity Integration (step-4) or Trigger Integration (step-5) when creating a Boltic integration workflow.

Choosing No for both options is not allowed, as the integration would have no functional purpose without an activity or a trigger.

  1. Search and select the appropriate integration group from the available option (e.g., serverless, Freshsales, and Google Workplace). You will get a success message when the integration is created.
🏆 Congratulations!

You've successfully created and launched your first Boltic Integration. You can now begin customizing your integration by editing schema files, defining resources, and building workflow logic.