Global & Model Webhooks

Overview

In Builder.io, Global Webhooks and Model Webhooks are mechanisms to trigger external actions when content changes occur. Here's a comparison:

1. Global Webhooks

Global webhooks apply to all content across all models in your Builder.io account. They are useful for broad actions that need to happen regardless of the model type.

Key Features

• Scope: Triggered by any changes (create, update, delete, etc.) across all models.
• Use Case: Ideal for actions like logging, notifications, or general integrations that don't depend on specific models.
• Setup: Configured once in the Builder.io settings.

How to Configure

1. Navigate to Settings > Webhooks in Builder.io.
2. Add a new webhook URL.
3. Define the event types (create, update, delete, etc.) to listen for.

2. Model Webhooks

Model webhooks are scoped to specific content models, allowing for more granular control and handling of specific content types.

Key Features

• Scope: Triggered only for changes within a specific model (e.g., page, product, blog).
• Use Case: Ideal for actions tied to a particular content model, such as syncing product updates with an e-commerce platform.
• Setup: Configured within the settings of the specific model.

How to Configure

1. Go to Models in Builder.io.
2. Select the model (e.g., page, product) you want to configure.
3. Add a webhook URL in the Webhooks section of the model settings.
4. Define the event types (create, update, delete, etc.) specific to the model.

When to Use Which?

• Use Global Webhooks for actions affecting the entire site or application (e.g., cache invalidation, global notifications).
• Use Model Webhooks for targeted actions related to specific content models (e.g., updating product inventory systems, blog syndication).