PlatformsREST Connector

REST Connector

Universal OpenAPI-based connector to integrate Field Nation with any system that provides an OpenAPI specification.

Overview

The REST Connector enables integration with any REST API that has an OpenAPI specification:

Upload OpenAPI spec: System automatically discovers endpoints and data models
Configure endpoints: Select CRUD operations from dropdown menus
Map fields: Use standard field mapping UI populated from spec
Basic Authentication: Simple username:password credentials
No code required: Configuration-driven setup

Key Features

Universal Compatibility

Works with ANY system that has an OpenAPI spec

Auto-Discovery

Automatically reads endpoints and models from spec

Simple Configuration

Select endpoints from dropdowns, no coding needed

Standard Mappings

Use familiar field mapping UI and transformations

How It Works

Upload OpenAPI Spec

Upload your system's OpenAPI (Swagger) specification file (JSON or YAML)

Configure Endpoints

Select endpoints for each operation from dropdown menus:

Record Metadata: Get field definitions
Record Fetch: Retrieve single record
Record Create: Create new records
Record Update: Update existing records
Attachments Upload: Upload files (optional)

Set Authentication

Provide Basic Auth credentials (username:password format)

Refresh Fields

Click "Refresh Fields" to fetch field definitions from your API

Map Fields

Configure standard field mappings using discovered fields

Test & Deploy

Test with sample data, then activate for production use

Architecture

Loading diagram...

When to Use REST Connector

✅ Use REST Connector When

⚠️ Limitations

The REST Connector is built for standard CRUD operations. It may not support:

Prop

Type

Description

Complex Workflows?Limitation

Multi-step processes, conditional branching, complex state machines

Advanced Transformations?Limitation

Complex business logic beyond standard field mappings and JSONNET

Custom Protocols?Limitation

Non-REST APIs, SOAP (unless REST wrapper available), GraphQL (direct)

Authentication Methods?Limitation

Only Basic Auth supported (OAuth, API keys, custom auth headers require REST API integration)

All API Features?Limitation

Built for one buyer's requirements - may need enhancement for additional functionality

Extensibility: The REST Connector was built for specific use cases and can be extended with additional functionality as needed. Contact Field Nation Support to discuss feature requirements.

Common Use Cases

Custom Pre built Connector Integration

Your company uses a proprietary Field Service Management system with REST API and OpenAPI spec.

Configuration:

Upload system's OpenAPI spec
Select /api/v1/tickets (create) endpoint
Select /api/v1/tickets/{id} (fetch/update) endpoints
Map Field Nation work order fields to ticket fields
Enable bidirectional sync for status updates

ERP System Integration

Integrate with mid-market ERP without pre-built connector.

Configuration:

Upload ERP's API specification
Select /work_orders/create endpoint
Select /work_orders/{id}/update endpoint
Map financial fields (cost, budget, billing codes)
Sync completion status back to ERP

Vertical-Specific Application

Industry-specific platform (healthcare, retail, manufacturing) with custom data models.

Configuration:

Upload application's OpenAPI spec
Map custom fields to application's unique data structures
Use JSONNET for industry-specific transformations
Sync status and completion data bidirectionally

Prerequisites

External System Requirements

Field Nation Requirements

Active buyer account with admin access
Integration settings access
Sandbox environment (recommended for testing)

Authentication

REST Connector uses Basic Authentication only:

Authorization: Basic base64(username:password)

Configuration:

Enter credentials in username:password format
Example: api_user:my_secure_password123
Field Nation encodes credentials automatically
Credentials encrypted at rest (AES-256)

Best Practices:

Use dedicated API user (not personal account)
Grant minimum required permissions
Rotate credentials periodically
Use strong, unique passwords

Supported Functionality

✅ What REST Connector Can Do

Create Records: Create records in external system when FN work order created/updated
Update Records: Update external records when FN work order status changes
Fetch Data: Retrieve field values from external system for field mapping
Field Mapping: Standard field mappings with all transformation actions
Custom Actions: JSONNET transformations for complex data manipulation
Attachments: Upload files to external system (if endpoint configured)
Bidirectional Sync: Status updates flow both directions
Correlation IDs: Track linked records across systems

⚠️ What REST Connector May Not Support

OAuth or API key authentication
Complex multi-step workflows
Real-time streaming data
GraphQL queries (REST only)
SOAP web services (REST only)
Custom headers or authentication schemes
Advanced error recovery beyond standard retries

For these requirements, consider REST API + Webhooks integration.

Comparison: REST Connector vs REST API

Feature	REST Connector	REST API + Webhooks
Setup Time	Hours	Days to weeks
Development	None (config only)	Full custom development
Authentication	Basic Auth only	All methods supported
OpenAPI Spec	Required	Optional (helpful)
Customization	Standard field mappings + JSONNET	Unlimited
Maintenance	Field Nation	Your team
Complex Workflows	Limited	Full control
Best For	Standard CRUD operations	Custom/complex integrations

Last updated on

Workflow Setup

Configure Smartsheet webhooks to trigger Field Nation work order creation when rows are added or updated.

Configuration

Configure the REST Connector by uploading your OpenAPI spec, selecting endpoints, and setting up authentication.

PlatformsREST Connector

REST Connector

Universal OpenAPI-based connector to integrate Field Nation with any system that provides an OpenAPI specification.

Overview

The REST Connector enables integration with any REST API that has an OpenAPI specification:

Upload OpenAPI spec: System automatically discovers endpoints and data models
Configure endpoints: Select CRUD operations from dropdown menus
Map fields: Use standard field mapping UI populated from spec
Basic Authentication: Simple username:password credentials
No code required: Configuration-driven setup

Key Features

Universal Compatibility

Works with ANY system that has an OpenAPI spec

Auto-Discovery

Automatically reads endpoints and models from spec

Simple Configuration

Select endpoints from dropdowns, no coding needed

Standard Mappings

Use familiar field mapping UI and transformations

How It Works

Upload OpenAPI Spec

Upload your system's OpenAPI (Swagger) specification file (JSON or YAML)

Configure Endpoints

Select endpoints for each operation from dropdown menus:

Record Metadata: Get field definitions
Record Fetch: Retrieve single record
Record Create: Create new records
Record Update: Update existing records
Attachments Upload: Upload files (optional)

Set Authentication

Provide Basic Auth credentials (username:password format)

Refresh Fields

Click "Refresh Fields" to fetch field definitions from your API

Map Fields

Configure standard field mappings using discovered fields

Test & Deploy

Test with sample data, then activate for production use

Architecture

Loading diagram...

When to Use REST Connector

✅ Use REST Connector When

⚠️ Limitations

The REST Connector is built for standard CRUD operations. It may not support:

Prop

Type

Description

Complex Workflows?Limitation

Multi-step processes, conditional branching, complex state machines

Advanced Transformations?Limitation

Complex business logic beyond standard field mappings and JSONNET

Custom Protocols?Limitation

Non-REST APIs, SOAP (unless REST wrapper available), GraphQL (direct)

Authentication Methods?Limitation

Only Basic Auth supported (OAuth, API keys, custom auth headers require REST API integration)

All API Features?Limitation

Built for one buyer's requirements - may need enhancement for additional functionality

Extensibility: The REST Connector was built for specific use cases and can be extended with additional functionality as needed. Contact Field Nation Support to discuss feature requirements.

Common Use Cases

Custom Pre built Connector Integration

Your company uses a proprietary Field Service Management system with REST API and OpenAPI spec.

Configuration:

Upload system's OpenAPI spec
Select /api/v1/tickets (create) endpoint
Select /api/v1/tickets/{id} (fetch/update) endpoints
Map Field Nation work order fields to ticket fields
Enable bidirectional sync for status updates

ERP System Integration

Integrate with mid-market ERP without pre-built connector.

Configuration:

Upload ERP's API specification
Select /work_orders/create endpoint
Select /work_orders/{id}/update endpoint
Map financial fields (cost, budget, billing codes)
Sync completion status back to ERP

Vertical-Specific Application

Industry-specific platform (healthcare, retail, manufacturing) with custom data models.

Configuration:

Upload application's OpenAPI spec
Map custom fields to application's unique data structures
Use JSONNET for industry-specific transformations
Sync status and completion data bidirectionally

Prerequisites

External System Requirements

Field Nation Requirements

Active buyer account with admin access
Integration settings access
Sandbox environment (recommended for testing)

Authentication

REST Connector uses Basic Authentication only:

Authorization: Basic base64(username:password)

Configuration:

Enter credentials in username:password format
Example: api_user:my_secure_password123
Field Nation encodes credentials automatically
Credentials encrypted at rest (AES-256)

Best Practices:

Use dedicated API user (not personal account)
Grant minimum required permissions
Rotate credentials periodically
Use strong, unique passwords

Supported Functionality

✅ What REST Connector Can Do

Create Records: Create records in external system when FN work order created/updated
Update Records: Update external records when FN work order status changes
Fetch Data: Retrieve field values from external system for field mapping
Field Mapping: Standard field mappings with all transformation actions
Custom Actions: JSONNET transformations for complex data manipulation
Attachments: Upload files to external system (if endpoint configured)
Bidirectional Sync: Status updates flow both directions
Correlation IDs: Track linked records across systems

⚠️ What REST Connector May Not Support

OAuth or API key authentication
Complex multi-step workflows
Real-time streaming data
GraphQL queries (REST only)
SOAP web services (REST only)
Custom headers or authentication schemes
Advanced error recovery beyond standard retries

For these requirements, consider REST API + Webhooks integration.

Comparison: REST Connector vs REST API

Feature	REST Connector	REST API + Webhooks
Setup Time	Hours	Days to weeks
Development	None (config only)	Full custom development
Authentication	Basic Auth only	All methods supported
OpenAPI Spec	Required	Optional (helpful)
Customization	Standard field mappings + JSONNET	Unlimited
Maintenance	Field Nation	Your team
Complex Workflows	Limited	Full control
Best For	Standard CRUD operations	Custom/complex integrations

Last updated on

Workflow Setup

Configure Smartsheet webhooks to trigger Field Nation work order creation when rows are added or updated.

Configuration

Configure the REST Connector by uploading your OpenAPI spec, selecting endpoints, and setting up authentication.

REST Connector

Your System Isn't Supported

You Have an OpenAPI Spec

Basic CRUD Operations Sufficient

Configuration-Driven Preferred

OpenAPI Specification

REST API Endpoints

Basic Authentication Support

Network Access

On this page

REST Connector

Your System Isn't Supported

You Have an OpenAPI Spec

Basic CRUD Operations Sufficient

Configuration-Driven Preferred

OpenAPI Specification

REST API Endpoints

Basic Authentication Support

Network Access

On this page