Webhook Overview

This document introduces the basic concepts and use cases of Webhooks.

What is a Webhook

A Webhook allows you to receive real-time notifications when data changes. When a configured event occurs, the system sends an HTTP POST request to the URL you specify.

Use Cases

Webhooks can be used for:

1. Data Synchronization - Synchronize data in real-time to other systems
2. Automation of Workflows - Trigger automated operations in other systems
3. Real-time Notifications - Receive real-time alerts for data changes
4. Data Backup - Back up critical data in real-time

Supported Events

Record Events

• record.create - Triggered when a record is created
• record.update - Triggered when a record is updated
• record.delete - Triggered when a record is deleted
• record.action - Manually triggered for single-row record operations
• record.bulk-action - Manually triggered for batch operations on records

Request Format

Basic Request Structure

{
  "type": "event type",
  "created_at": "time of event occurrence",
  "data": {
    "base_id": "base ID",
    "table_name": "table name",
    "records": [
      // related record data
    ]
  }
}

Best Practices

1. Verify the signature of each request
2. Respond quickly to webhook requests
3. Use asynchronous processing mechanisms
4. Implement idempotent processing
5. Ensure error handling and logging