Developer Documentation

Basemulti provides powerful REST APIs and Webhook functionality that allows you to easily integrate Basemulti into your applications. This documentation will help you understand how to use these features.

API Overview

Basemulti's API follows RESTful design principles and provides the following features:

• CRUD operations for records
• Bulk operation support
• Field filtering and sorting
• Pagination
• Relational data queries

API Authentication

All API requests require authentication. Basemulti uses a Header Token authentication mechanism:

x-bm-token: your_api_token

You can generate and manage API Tokens in your workspace settings.

Base URL

The base URL format for the API is:

https://your-domain.com/api

Response Format

All API responses use JSON format and contain the following basic structure:

{
  // Response data
}

Error Handling

When an error occurs, the API will return the appropriate HTTP status code and error message:

{
  "message": "Error description"
}

Webhook Overview

Webhooks allow you to receive notifications when specific events occur. Supported events include:

• Record creation
• Record updates
• Record deletion
• Manual triggers

Webhook Configuration

You can configure multiple webhooks for each table, and each webhook can:

• Select event types to listen for
• Set a target URL

Webhook Request Format

When an event is triggered, the webhook sends a POST request to your configured URL with a request body containing:

{
  "type": "record.create",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base_id",
    "table_name": "table_name",
    "records": [
      // Event-related data
    ]
  }
}

Next Steps

• Learn how to use the Record List API
• Understand the Record Detail API
• Master the Record Create API
• Explore the Record Update API
• Use the Record Delete API
• Configure and manage Webhooks