Integration API

Integration API provides endpoints for configuring outbound integrations. Tenants can register webhook URLs, configure pre-built connectors, and subscribe to domain events for relay to external systems.

Endpoints

GET /api/v1/integrations/webhooks — List registered webhooks
POST /api/v1/integrations/webhooks — Register a new webhook
DELETE /api/v1/integrations/webhooks/{id} — Remove a webhook
GET /api/v1/integrations/connectors — List available connectors
POST /api/v1/integrations/connectors/{id}/activate — Activate a connector

Relationships

◇ Composes outgoing 1

Target Element	Element Type
Integration Gateway	Software Subsystem

◇ Part of incoming 1

Source Element	Element Type
Integration Gateway	Software Subsystem

→ Served by incoming 13

Source Element	Element Type
Audit Alert Triggered	Domain Event
Contact Created	Domain Event
Contact Updated	Domain Event
Customer Profile Merged	Domain Event
Export Completed	Domain Event
Health Score Changed	Domain Event
Onboarding Completed	Domain Event
Tenant Created	Domain Event
Tenant Deactivated	Domain Event
Tenant Reactivated	Domain Event
Tenant Suspended	Domain Event
Webhook Delivered	Domain Event
Webhook Failed	Domain Event

Architecture Context

Diagrams

Domain Context Map

views/customer-management/technology/Domain_Context_map.drawio

Properties

Type API Endpoint

Layer Application

Domain Customer Management

Status active

Owner Platform Team

Additional Metadata

Protocol REST/JSON

Archimate Type application-interface

Meta Model

Business

Organization

Application current

Technology