Integration Spec Block
Document system integrations with source/target systems, protocols, endpoints, and operational details. Create complete integration specifications.
The Integration Spec block documents system-to-system integrations. Capture source and target systems, protocols, endpoints, authentication methods, and operational details for complete integration documentation.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Name | Yes | Integration name |
| Source System | No | Where data originates |
| Target System | No | Where data is sent |
| Integration Pattern | No | Sync, Async, Batch, Event-Driven, or Pub/Sub |
| Protocol | No | REST, GraphQL, gRPC, SOAP, Message Queue, or File Transfer |
| Data Format | No | JSON, XML, CSV, Protobuf, or Avro |
| Authentication | No | None, API Key, OAuth2, JWT, mTLS, or Basic Auth |
| Description | No | Purpose and scope of the integration |
| Endpoints | No | Array of API endpoints |
| Error Handling | No | How errors are managed |
| Retry Policy | No | Retry strategy |
| SLA | No | Performance requirements |
Endpoint Properties
| Property | Required | Description |
|---|---|---|
| Method | Yes | HTTP method (GET, POST, PUT, DELETE, etc.) |
| URL | Yes | Endpoint URL or path |
| Name | No | Human-readable endpoint name |
| Description | No | What the endpoint does |
Integration Patterns
Example: REST API Integration
A synchronous REST integration between systems.
Example: Event-Driven Integration
An asynchronous event-based integration.
Example: Batch Integration
A scheduled file-based data transfer.
Editing Integration Specs
| Action | How To |
|---|---|
| Set Systems | Enter source and target system names |
| Choose Pattern | Select integration pattern from dropdown |
| Add Endpoints | Click Add Endpoint and fill in method, URL, and details |
| Set Authentication | Choose authentication type from dropdown |
| Preview | View the source-to-target visualisation with method badges |