Webhook Detailed Explanation

This document provides a detailed explanation of the Webhook request format and usage.

Webhook Configuration

On the Webhook management page, you can configure the Webhook's URL, select the events to trigger, and set the conditions and logic for event triggering.

1. Click the "Webhooks" button on the table settings page
2. Click the "Create Webhook" button
3. In the pop-up form, fill in the Webhook's name and endpoint URL, select the methods and event types to trigger
4. Click the "Submit" button to complete the configuration

Event Format Explanation

Record Creation Event

Automatically triggered when a new record is created:

Event name: record.create

{
  "type": "record.create",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base123",
    "table_name": "contacts",
    "records": [
      {
        "id": "11",
        "name": "Test Record",
        "created_by": "usrIL1t20OwVvW9jXzT",
        "updated_by": "usrIL1t20OwVvW9jXzT",
        "created_at": "2024-11-20T17:30:12.000Z",
        "updated_at": "2024-11-20T17:30:27.000Z"
      }
    ]
  }
}

Record Update Event

Automatically triggered when a record is updated:

Event name: record.update

{
  "type": "record.update",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base123",
    "table_name": "contacts",
    "records": [
      {
        "id": "11",
        "name": "Updated Name",
        "created_by": "usrIL1t20OwVvW9jXzT",
        "updated_by": "usrIL1t20OwVvW9jXzT",
        "created_at": "2024-11-20T17:30:12.000Z",
        "updated_at": "2024-11-20T17:35:27.000Z"
      }
    ]
  }
}

Record Deletion Event

Automatically triggered when a record is deleted:

Event name: record.delete

{
  "type": "record.delete",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base123",
    "table_name": "contacts",
    "records": [
      {
        "id": "11",
        "deleted_at": "2024-11-20T17:40:27.000Z"
      }
    ]
  }
}

Single Record Trigger Event

Triggered by individual operations:

Event name: record.action

{
  "type": "record.action",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base123",
    "table_name": "contacts",
    "records": [
      {
        "id": "11",
        "name": "Test Record",
        "created_by": "usrIL1t20OwVvW9jXzT",
        "updated_by": "usrIL1t20OwVvW9jXzT",
        "created_at": "2024-11-20T17:30:12.000Z",
        "updated_at": "2024-11-20T17:30:27.000Z"
      }
    ]
  }
}

Bulk Operation Event

Triggered by bulk operations:

Event name: record.bulk-action

{
  "type": "record.bulk-action",
  "created_at": "2024-12-09T20:32:45.534Z",
  "data": {
    "base_id": "base123",
    "table_name": "contacts",
    "records": [
      {
        "id": "11",
        "name": "Test Record",
        "created_by": "usrIL1t20OwVvW9jXzT",
        "updated_by": "usrIL1t20OwVvW9jXzT",
        "created_at": "2024-11-20T17:30:12.000Z",
        "updated_at": "2024-11-20T17:30:27.000Z"
      }
    ]
  }
}