Skip to main content

Overview

Beyond built-in integrations, Firstwork provides an App Integration framework that enables you to connect with any external system. This framework supports custom authentication, data mapping, and action execution through a configurable interface.

App Integration Framework

App Integrations

An App Integration represents a connection to an external service:
ConfigurationDescription
NameIntegration identifier
Base URLExternal service API base URL
AuthenticationAuth method (API key, OAuth, Basic)
HeadersDefault HTTP headers
Rate LimitsRequest rate limiting configuration

App Integration Actions

App Integration Actions are automation actions that call external APIs:
ConfigurationDescription
EndpointAPI endpoint path
MethodHTTP method
Request BodyPayload template with variables
Response MappingHow to process the response
Error HandlingBehavior on failure

Custom Objects

Custom Objects allow you to define custom data structures:
  • Create custom entity types with custom fields
  • Store data from external integrations
  • Reference custom objects in compliance rules
  • Use custom object data in automation templates

RPA (Robotic Process Automation)

For integrations that don’t have APIs, Firstwork provides RPA capabilities:

RPA Components

ComponentDescription
RPA JobA defined automation task
RPA InstructionsStep-by-step browser automation instructions
RPA ExecutionRecord of an RPA run
Input/Output VariablesData passed to and from RPA jobs

How RPA Works

Use Cases

  • Fill forms on external government websites
  • Extract data from legacy systems
  • Automate repetitive manual tasks
  • Bridge systems without APIs

Data Sync Framework

The Data Sync framework provides structured data synchronization:
ComponentDescription
Data SyncSync configuration (source, destination, mapping)
Data Sync RunIndividual sync execution record
Field MappingHow fields map between systems
ScheduleAutomatic sync schedule

Sync Capabilities

  • Bidirectional data synchronization
  • Incremental and full sync modes
  • Conflict detection and resolution
  • Audit trail of all sync operations
  • Error handling with automatic retry

Chat Integration (Dixa)

Firstwork integrates with Dixa for customer support chat:
  • Sync conversation history
  • Link chat interactions to applications
  • Trigger automations from chat events
  • Access chat data in compliance rules

Building Custom Integrations

1

Define the integration

Create an App Integration with the external service’s API details.
2

Create actions

Define App Integration Actions for each API call you need to make.
3

Map data

Configure how Firstwork data maps to the external API’s request format.
4

Process responses

Define how API responses should be processed and stored in Firstwork.
5

Connect to automations

Use the App Integration Action in your automations to trigger the integration.