Integration

An Integration establishes connections with external services, or lets you extend or customize your MagicBell setup.

Configuration

Each Integration provides a structured configuration process. This is the only essential component of an integration, and all other features listed below are optional.

• Provider Config: Settings required to connect with a third-party service.
• Authentication: API keys, OAuth tokens, and other credentials.
• Validation: Ensures the Integration is properly configured.

Installation

Integrations that require setup offer an installation process:

• Setup Flow: OAuth-based or manual setup procedure.
• Configuration Storage: Securely stores connection details.
• Verification: Tests the connection with the external service.

Incoming-Webhook

Integrations can receive and process webhook events from the service they integrate with.

• Event Validation: Verifies authenticity of received webhook event.
• Event Decoding: Transforms external data into MagicBell events.
• Event Routing: Directs events to appropriate handlers.

Integrations process webhook events from integrated services by offering support for

• Event Types: Define supported event schema to offer validation and data mapping to supported actions.
• Processing: Convert external events into broadcasts, user update, or other actions.

Interaction with other primitives

Integrations interact with several other MagicBell primitives:

• Channel: Provide channel delivery.
• Broadcast: Broadcast to recipients with data plucked from the event.
• User: Update user data for personalizing notifications.

Each Integration type has specific capabilities, configuration requirements, and event formats detailed in its own documentation.