Core Concepts

A deeper look at the terms introduced in Quick Start.

1. API

A communication protocol for exchanging data between programs.

In 3Min API:

• Create APIs without backend code
• Receive standard JSON data
• Data is automatically stored and can be forwarded via webhooks

2. Endpoint

The API address that receives data. One API = one endpoint.

Each endpoint includes:

• Unique URL path (auto-generated)
• Required fields (optional)
• Sandbox/Production environment separation
• Environment-specific API keys (tm_test_xxx..., tm_live_xxx...)

3. JSON

3Min API accepts standard JSON data.

Supported field types:

Example (order info):

{
  "order_id": "ORD-2024-001",
  "amount": 45000,
  "items": ["Item A", "Item B"],
  "paid": true,
  "customer": {
    "name": "John Doe",
    "phone": "010-1234-5678"
  }
}

4. Required Fields (Optional)

You can specify fields that must be included in JSON data.

With required fields:

• Requests missing required fields are rejected (400 error)
• Ensure data quality
• String fields can be made searchable in logs

5. Sandbox vs Production

• Environment is determined by API key prefix
• Webhooks can be configured separately per environment
• Test thoroughly in Sandbox before deploying to Production

6. API Key

Used for authentication when calling endpoints. The owner's default API key is automatically generated when the endpoint is created and cannot be deleted. If the key is compromised, it can be regenerated.

Collaboration Keys

Create collaboration keys and invite collaborators to manage logs and statistics separately per collaboration key.

Filter logs by collaboration key to track usage per collaboration key.

Set allowed operations (POST/GET/PUT/DELETE) per collaboration key, independently for each environment.

7. Webhooks

Automatic notifications sent to a specified URL when data arrives.

Two types of webhooks:

Retry policy: Up to 3 retries on failure (60-second intervals)

Note: Even if all webhook retries fail, your data is still stored safely. Check webhook status in the logs.

8. Event Alerts (Discord / Slack / Telegram)

Receive instant notifications for important events via Discord, Slack, or Telegram.

Setup: Dashboard → APIs → Endpoint detail → Notification settings

Supported events:

• Webhook delivery failure (notifies the affected party only)
• Monthly usage 80% warning (owner only)
• Monthly usage limit exceeded (owner only)
• New deployment request (owner only)
• Deployment complete (collaborator only)

Note: Alerts are best-effort. Delivery failures are not retried and notification history is not stored.

9. Data Archiving

Production data is automatically archived after 30 days. Archived record metadata (status, timestamps, webhook results, etc.) is preserved, while the payload (body data) is moved to separate storage.

Policy by environment:

After archiving:

• Records remain visible in the log list (metadata preserved)
• Payload search is limited to the most recent 30 days
• Individual record payloads can be viewed via "View original"

Archive download:

• Location: Dashboard > Archives
• JSONL.gz: full records with all system fields (raw archive)
• CSV: payload fields only, recursively flattened (max depth 5), Excel-compatible (UTF-8 BOM)
• Each file contains one day's production records
• Available on paid plans only