Endpoint configuration overview

Endpoint configuration defines how adapters communicate with external APIs. Configure API endpoints in action.json and data structures in schema.json.

What is endpoint configuration

Endpoint configuration consists of two components that work together:

Actions (action.json) - Define API operations

• Which endpoints to call
• How to construct requests
• How to handle responses

Schemas (schema.json) - Define data structures

• Validate request data
• Transform field names
• Parse response data

How actions and schemas work together

File structure

Endpoint configuration files are organized by entity:

entities/
  Users/
    action.json          # API operations for users
    schema.json          # Data structures for users
  Devices/
    action.json          # API operations for devices
    schema.json          # Data structures for devices

Entity - Logical grouping of related API endpoints (Users, Devices, Tickets, etc.)

Configuration workflow

When to configure endpoints

Configure actions when you need to:

• Call external API endpoints
• Add new operations to existing adapters
• Modify how requests are constructed
• Change timeouts or headers

Configure schemas when you need to:

• Validate data before sending to APIs
• Translate field names between systems
• Parse or transform response data
• Secure sensitive fields

Generated vs manual configuration

Adapter Builder (generated)

Adapter Builder can generate configuration from OpenAPI specifications:

• Creates actions for all endpoints
• Generates schemas from API documentation

Best for: New adapters, standardized APIs, rapid prototyping

Manual configuration

Create or modify configuration files directly:

• Add custom transformations
• Handle non-standard APIs
• Optimize for specific use cases

Best for: Custom integrations, API gaps, specialized requirements

What’s next