Integration Spec Block
Document system integrations with source/target systems, protocols, data formats, and endpoint specifications.
Overview
The Integration Spec block documents system-to-system integrations with technical details including protocols, data formats, authentication, endpoints, and operational characteristics. Use this block to create complete integration documentation.
REST API Integration
A synchronous REST API integration between systems.
Event-Driven Integration
An asynchronous event-driven integration using message queues.
Block Properties
| Property | Required | Description |
|---|---|---|
| name | Yes | Integration name |
| sourceSystem | Yes | System sending data |
| targetSystem | Yes | System receiving data |
| integrationPattern | No | Pattern type (sync, async, batch, event-driven, pub-sub) |
| protocol | No | Communication protocol (REST, GraphQL, gRPC, SOAP, Message Queue, File Transfer) |
| dataFormat | No | Data format (JSON, XML, CSV, Protobuf, Avro) |
| authentication | No | Auth method (None, API Key, OAuth2, JWT, mTLS, Basic Auth) |
| description | No | Integration description |
| endpoints | No | Array of endpoint specifications |
| errorHandling | No | How errors are handled |
| retryPolicy | No | Retry behaviour |
| sla | No | Performance expectations |