Overview

This is the Development section of the Boltic Integration builder documentation, which provides a complete process for building integrations. It explains the purpose and structure of key configuration files, including the boilerplate, base schema, authentication schema, resource schema, and webhook schema. Each page guides developers on how to define API operations, securely handle authentication, and configure real-time triggers using webhooks.

📄️ Boilerplate Overview

Boilerplate is a pre-written codebase that speeds up development by providing a foundational template for building extensions.

📄️ Base Setup

It controls how users authenticate, select resources, and interact with various features via UI-driven parameters. This section outlines the key fields used in base.json and their link to the corresponding modules in the resources/ directory.

📄️ Authentication

This document explains how to configure the Authentication file for integrations. There are several methods available to authenticate, such as using API keys or credentials. You will define UI parameters (e.g., API Key, credentials), validate credentials against an endpoint, and fetch tokens dynamically. Later in this section, we will show a use case for dynamic token fetching. Clear, correct configuration ensures only authorized access to external services.

📄️ Resource

Within the Boltic Integration boilerplate, the resources directory contains JSON schemas for specific resources related to your integration. Each schema is designed to define the parameters and operations associated with that specific resource. This organization ensures that each resource comes with its own configurable parameters and operational logic.

📄️ Specification

The Specification (spec.json) file contains metadata about the specifications of the activity, ensuring all users and systems interact with the correct version.

📄️ Webhook

Webhooks enable real-time communication between external services and the platform. The webhook schema (webhook.json file) defines the contract for creating dynamic triggers that respond to external events, allowing workflows to be initiated automatically when specific conditions are met in integrated services.

🗃️ Documentation

2 items

🗃️ Advance

4 items