Skip to main content

Overview

This document catalogs the key data objects in the Firstwork platform. For each object, it describes what the object represents, how it is created and modified, and how it relates to other objects.

Core Entities

Company

A tenant organization on the platform.
AttributeDescription
NameCompany display name
SlugURL-friendly identifier
Logo & BrandingVisual identity
Legal EntitiesSubsidiary organizations
Allowed LanguagesLanguages available to applicants
Created by: Platform staff Modified by: Company admins (Settings)

User

A person with an account on the platform.
AttributeDescription
NameFirst name, last name, optional middle name
EmailPrimary email address
PhoneOptional phone number
AvatarProfile picture
Language PreferencePreferred interface language
Created by: Registration, invite, admin creation, or API Modified by: The user (Profile page) or admins

Contract

The relationship between a user and a company — representing employment or contractor agreement.
AttributeDescription
UserThe associated person
CompanyThe associated company
StatusCurrent contract status (Active, Inactive, etc.)
Legal EntityAssigned legal entity
Onboarding FlowAssigned onboarding process
Created by: “Create Contract” automation action, admin, or API Modified by: “Update Worker Stage” automation action or admin

Application

A candidate’s submission to a hiring flow.
AttributeDescription
CandidateThe applicant
Hiring FlowThe pipeline being applied to
Current StageWhere the candidate is in the pipeline
Form SubmissionThe candidate’s form responses
Recollection StatusWhether documents need re-submission
Created by: Candidate signup, API, bulk import, or “Create Application” automation action Modified by: Stage transitions, compliance rules, automation actions, admin actions

Hiring Flow

A recruitment pipeline definition.
AttributeDescription
NameFlow name
TypeStandard or Module
FormThe associated form structure
SettingsRecollection config, stage groups, multi-application settings
Created by: Admin Modified by: Admin (Form Builder, Settings)

Form Entities

Form

The container for all pages, stages, and questions within a flow.
AttributeDescription
PagesOrdered list of form pages
StagesStatus checkpoints
Compliance RulesDecision logic attached to pages

Form Element (Question)

An individual question or content block within a page.
AttributeDescription
TypeThe element type (text, email, number, selection, document upload, etc.)
TitleDisplay label
Helper TextInstructional text
RequiredWhether a response is mandatory
PositionOrder within the page
Type-Specific SettingsValidation rules, format, options, etc.

Form Submission

A candidate’s or worker’s responses to a form.
AttributeDescription
FormThe form being submitted
RespondentThe person submitting
Page ResponsesAnswers organized by page
StatusCurrent submission status

Automation Entities

Automation

A configured workflow with triggers, conditions, and actions.
AttributeDescription
NameDisplay name
DescriptionWhat the automation does
ActiveWhether the automation is enabled
ContextHiring Flow, People/Onboarding, or Check-in Form
Linked FlowThe specific flow this automation is scoped to
TriggersWhat starts the automation
ActionsWhat the automation does
Input VariablesParameterization data
Execution PolicyQueue, Skip, or Continue

Automation Execution

A record of a single automation run.
AttributeDescription
AutomationWhich automation ran
Trigger EventWhat started it
StatusSuccess, failure, or skipped
TimingStart time, end time, duration
Action ResultsPer-action status, input, output, and errors

Scheduling Entities

Schedule

A definition of when a resource is available.
AttributeDescription
NameSchedule name
Availability WindowsDays and time ranges

Event

A bookable appointment type.
AttributeDescription
TitleEvent name
DurationMeeting length
LocationVirtual (Google Meet) or In Person
ScheduleLinked availability

Booking

A confirmed appointment reservation.
AttributeDescription
EventThe booked event
CandidateWho booked it
Time SlotReserved date and time
StatusPending, Confirmed, Cancelled, or Completed

Meeting Queue Enrollment

A candidate’s position in a meeting queue.
AttributeDescription
QueueThe meeting queue
CandidateThe enrolled person
StatusWaiting, Active, Cancelled, Completed, Failed
PositionQueue position

AI Caller Entities

AI Caller Bot

A configured AI voice bot.
AttributeDescription
NameBot name
System PromptConversation script
VoiceSelected voice
Input VariablesData provided before the call
Output VariablesData to capture during the call
SettingsTurn detection, speed, summarization, call duration limit

Call Enrollment

A record of a single call.
AttributeDescription
BotWhich AI Caller was used
TypeTest, Automation, or Form
Call MethodPhone, Audio, or Video
StatusInitiated, In Progress, Completed, or Failed
TranscriptFull conversation text
SummaryAI-generated call summary
Output ValuesCaptured structured data
RecordingAudio recording (if enabled)

AI Agent Entities

AI Agent

A configured browser automation bot.
AttributeDescription
NameAgent name
DescriptionWhat the agent does
ScopeCompany-specific or Global
InstructionsThe workflow of browser actions
Input VariablesData provided before execution
Output VariablesData captured during execution
StatesNamed workflow checkpoints

Agent Execution

A record of a single agent run.
AttributeDescription
AgentWhich agent ran
StatusExecution status
Input DataValues provided
Output DataValues captured
LogsDetailed execution logs
TimingStart and end timestamps

LMS Entities

Course

A training course.
AttributeDescription
TitleCourse name
DescriptionCourse overview
StatusDraft, Active, or Inactive
Cover ImageThumbnail
LessonsContent built via Form Builder
Certificate ConfigValidity period (months or years)

Enrollment

A learner’s assignment to a course.
AttributeDescription
CourseThe assigned course
LearnerThe enrolled person
StatusActive, Completed, or Cancelled
Due DateEnrollment deadline
ScoreQuiz score (if applicable)

Configuration Entities

Integration

A connected third-party service.
AttributeDescription
TypeHotjar, GTM, Sterling, Veriff, Google Calendar, Google Sheets, Google Gmail
StatusConnected or Disconnected
CredentialsType-specific configuration (API keys, OAuth tokens, etc.)

API Key

A credential for external API access.
AttributeDescription
NameKey label
StatusActive or Revoked

Tag

A categorization label applied to applications, automations, or other records.

Feature Flag

A toggleable platform feature.
AttributeDescription
NameFlag identifier
EnabledGlobal on/off state
Allow ListCompanies/applications where the flag is explicitly enabled
Block ListCompanies/applications where the flag is explicitly disabled

Compliance Rule

A decision rule attached to a form page.
AttributeDescription
ConditionsTree of AND/OR logic with field comparisons
TypeRecollection, Assignment, or Navigation
ActionsWhat happens when the rule fires
AI EvaluationOptional AI-assisted rule assessment

Custom Variable

A computed data field.
AttributeDescription
TypeAggregated (across records) or Annotated (per record)
FunctionSum, count, average, min, max, mean, mode, or median
Source FieldsData paths used for computation

Task

A manual review item for admins or workers.
AttributeDescription
TitleTask description
StatusPending, In Progress, or Completed
PriorityUrgency level
Due DateDeadline
ActionWhere to navigate to handle the task