Documentation
Integrating Civagent with Tyler Technologies
Tyler Technologies operates across thousands of government locations with products spanning ERP (Munis, Incode), permitting (EnerGov), courts (Odyssey), appraisal (iasWorld), and data transparency (Socrata). This guide covers connecting Civagent to Tyler deployments through their API infrastructure, enabling conversational access to financial records, permit status, court filings, and open data portals.
Overview
Tyler’s product suite differs from website-centric platforms. Rather than embedding widgets on a CMS, Civagent integrations with Tyler focus on backend data access—querying Munis for payment status, checking EnerGov for permit progress, or searching Socrata datasets for public records. The conversational interface can surface on municipal websites, kiosks, or dedicated portals while Tyler systems serve as the authoritative data source.
Civagent agents connect to Tyler products through:
- API Toolkits: Direct access to Tyler application modules
- API Connectors: Pre-built integrations for common third-party use cases
- Socrata SODA API: Programmatic access to open data portals
Tyler API Architecture
Toolkits vs. Connectors
Tyler’s API Catalog exposes two integration mechanisms:
API Toolkits contain all resources available in a specific Tyler module. Use these when you need comprehensive access to a product area:
| Module | Typical Queries |
|---|---|
| General Ledger | Budget status, fund balances, expenditure tracking |
| Accounts Receivable | Payment history, outstanding balances, billing records |
| Utility Billing | Account lookup, consumption data, payment processing |
| Permits and Code Enforcement | Permit status, inspection results, violation history |
| Purchase Orders | Procurement status, vendor information |
| Asset Management | Infrastructure records, maintenance history |
| Service Requests | 311 intake, work order status, resolution tracking |
API Connectors provide targeted integrations for specific use cases:
- Citizen self-service portals
- Cashiering applications
- Interactive voice response (IVR) systems
- Applicant tracking systems
Civagent typically uses Toolkits for read operations (status lookups, record retrieval) and Connectors when interfacing with citizen-facing workflows.
Authentication
Tyler’s API Developer Portal manages access credentials. Obtain API keys through your Tyler account representative. Civagent stores credentials in encrypted environment variables per jurisdiction—never exposed to the conversational interface.
Product-Specific Integrations
Munis / Enterprise ERP
Munis handles core financials, HR, payroll, procurement, and revenue management. Common Civagent queries against Munis data:
Utility Billing
- “What’s my water bill balance?”
- “When is my next payment due?”
- “Show me my usage for the last six months”
Accounts Receivable
- “Do I have any outstanding fees?”
- “What permits have I paid for this year?”
Business Licensing
- “Is my business license current?”
- “When does my liquor license expire?”
The agent queries Munis through the Utility Billing and Accounts Receivable toolkits, returning balances and due dates. Payment processing routes to your existing payment portal—Civagent provides information but does not handle financial transactions directly.
EnerGov / Enterprise Permitting
EnerGov manages permits, inspections, code enforcement, and licensing across 750+ agencies. Integration points:
Permit Status
- “What’s the status of my building permit?”
- “Has my inspection been scheduled?”
- “What documents are missing from my application?”
Code Enforcement
- “Are there any open violations on this property?”
- “What’s the deadline for compliance?”
Contractor Licensing
- “Is this contractor licensed in the county?”
- “When does their license expire?”
EnerGov’s Collaborator Portal API enables queries against permit records. The agent returns status updates, scheduled inspection dates, and outstanding requirements. Residents track progress without calling the permits office.
GIS Integration Note: EnerGov integrates with Esri services for address validation and spatial workflows. Civagent can cross-reference EnerGov permit data with parcel information when both systems share the same GIS infrastructure.
Odyssey / Enterprise Justice
Odyssey serves court case management across 600+ counties in 21 states. Integration requires careful attention to public records boundaries—court data includes both public docket information and sealed records.
Public Docket Queries
- “What’s the next hearing date for case number X?”
- “Has a judgment been entered?”
- “What’s the filing deadline?”
E-Filing Status
- “Was my filing accepted?”
- “What rejection reason was given?”
Civagent connects through Odyssey’s case management APIs for public record queries only. The agent does not access sealed records, juvenile cases, or protected party information. Court staff define which case types and data elements are exposed through the API.
iasWorld / Appraisal
iasWorld is Tyler’s computer-assisted mass appraisal (CAMA) system. Property assessment queries:
- “What’s the assessed value of this property?”
- “When was the last appraisal?”
- “What comparable sales were used?”
Integration typically routes through the county’s open data portal (Socrata) rather than direct iasWorld API access, since assessment data is public record.
Socrata Open Data Integration
Tyler acquired Socrata in 2018. The platform now powers open data portals for federal agencies (DOT, CMS), states (Alaska, Ohio), and hundreds of local governments. Civagent queries Socrata datasets through the SODA API.
SODA API Capabilities
The Socrata Open Data API supports:
- REST endpoints for dataset queries
- SoQL query language for filtering, aggregation, and transformation
- Multiple formats: JSON, GeoJSON, CSV, RDF-XML
- Geographic data types: Point, Polygon, Line, MultiPolygon
Common Dataset Categories
| Category | Example Queries |
|---|---|
| Financial | “What’s the city’s budget for parks this year?” |
| Public Safety | “How many traffic accidents occurred last month?” |
| Property | “What permits were issued on Main Street?” |
| Elections | “Where are the polling places in my precinct?” |
| Environment | “What’s the air quality index today?” |
Query Example
A resident asks: “What building permits were issued last week?”
Civagent constructs a SoQL query against the permits dataset:
GET /resource/permits.json?$where=issue_date > '2026-01-20'
The response returns permit records matching the date filter. The agent summarizes: “47 building permits were issued last week, including 12 residential additions, 8 commercial renovations, and 27 roof replacements.”
Dataset Discovery
Socrata portals expose a data.json catalog for dataset discovery. Civagent indexes available datasets during jurisdiction setup, enabling the agent to route questions to appropriate data sources without hardcoded mappings.
Integration Patterns
Read-Only Data Access
Civagent operates in read-only mode against Tyler systems. The agent retrieves information but does not create, update, or delete records. This boundary:
- Prevents accidental data modification
- Simplifies security review
- Aligns with public records access patterns
Write operations (permit applications, payments, service requests) route to Tyler’s native portals with appropriate authentication.
Caching Strategy
Tyler API rate limits vary by product and licensing tier. Civagent caches:
- Reference data (permit types, fee schedules, district boundaries): 24-hour TTL
- Status queries (permit progress, case docket): 15-minute TTL
- Financial data (balances, payments): No caching—always live query
Cache invalidation triggers on known update events when webhook integration is available.
Error Handling
When Tyler APIs return errors:
- Authentication failures: Agent reports system unavailability, does not expose credential details
- Rate limits: Agent queues request, informs user of delay
- Not found: Agent confirms no matching record exists
- Server errors: Agent suggests alternative contact methods (phone, in-person)
The agent does not fabricate data when API calls fail.
Compliance Considerations
Data Retention
Civagent maintains conversation logs separately from Tyler system data. Configure retention policies to match your jurisdiction’s requirements:
- Conversation records: Align with public records retention schedules
- Audit logs: Maintain per state records law
- Legal holds: Suspend deletion for pending litigation or records requests
Tyler system data retention is governed by Tyler product configuration—Civagent does not modify Tyler retention settings.
Audit Trail
All queries against Tyler APIs generate audit records documenting:
- Timestamp and agent session
- API endpoint accessed
- Query parameters (excluding PII)
- Response status
Audit logs support public records responses and compliance reviews.
Court Data Boundaries
Odyssey integration requires explicit configuration of accessible case types. By default, Civagent excludes:
- Sealed and expunged records
- Juvenile cases
- Mental health proceedings
- Domestic violence protective orders (protected party information)
Court administrators define the public records boundary. The agent operates within that configuration.
Deployment Architecture
Direct API Integration
[Resident] → [Civagent] → [Tyler API Gateway] → [Munis/EnerGov/Odyssey]
Civagent authenticates with Tyler APIs using jurisdiction-specific credentials. Responses stream back through WebSocket connection to the user interface.
Socrata Integration
[Resident] → [Civagent] → [SODA API] → [Socrata Portal]
Open data queries use application tokens for rate limit management. Public datasets do not require user authentication.
Hybrid Deployment
Large jurisdictions often run multiple Tyler products. Civagent routes queries to appropriate backends:
| Query Type | Backend |
|---|---|
| Bill payment status | Munis Utility Billing API |
| Permit inspection | EnerGov Permits API |
| Court hearing date | Odyssey Case Manager API |
| Crime statistics | Socrata Public Safety dataset |
| Property assessment | Socrata/iasWorld dataset |
Routing logic uses intent classification to match resident questions with appropriate data sources.
Implementation Checklist
Pre-deployment
- [ ] Identify Tyler products in use (Munis, EnerGov, Odyssey, iasWorld)
- [ ] Obtain API Developer Portal access from Tyler account team
- [ ] Document which API Toolkits and Connectors are licensed
- [ ] Inventory Socrata datasets if open data portal exists
- [ ] Define court data accessibility boundaries with court administrators
Configuration
- [ ] Generate API credentials for each Tyler product
- [ ] Configure Civagent environment with Tyler endpoints and keys
- [ ] Set up Socrata application tokens for open data access
- [ ] Define caching policies by data type
- [ ] Test queries against each integrated system
Deployment
- [ ] Deploy Civagent interface (embedded widget, standalone portal, or kiosk)
- [ ] Verify API connectivity across all Tyler backends
- [ ] Confirm rate limit headroom for expected query volume
- [ ] Test error handling scenarios
Monitoring
- [ ] Review API usage against rate limits
- [ ] Monitor query response times
- [ ] Track audit logs for compliance reporting
- [ ] Measure staff time savings on routine inquiries
Agent Modules
Enable modules based on Tyler products deployed:
Permits
Queries EnerGov for permit status, inspection scheduling, and contractor licensing. Answers questions like “What do I need to open a restaurant?” by referencing permit requirements and fee schedules.
Records
Searches Socrata datasets and public court records for records requests. Locates responsive documents, tracks request status, supports FOIA/public records workflows.
311
Receives service requests, classifies by department, checks status against Tyler Service Requests module. Routes complex cases to staff while handling routine status inquiries automatically.
Courts
Provides public docket information from Odyssey—hearing dates, filing deadlines, case status. Operates strictly within configured public records boundaries.
Billing
Queries Munis for utility account status, payment history, and balance information. Directs residents to payment portals for transactions.
Operational Notes
Human Oversight: Agents surface information from Tyler systems. Staff review and approve any actions that modify records, process payments, or generate official correspondence.
Source Attribution: Every response cites the Tyler system and query used. When the agent reports a permit status, it identifies EnerGov as the source. Audit trails document the exact API call.
Multi-language: The conversational interface handles queries in multiple languages. A resident asking “¿Cuándo es mi próxima audiencia?” receives a response in Spanish using the same Odyssey data.
No Data Training: Civagent does not train on Tyler system data or conversation logs. Customer data remains within the municipal tenant with no third-party sharing.
Support
For Tyler API access and licensing questions, contact your Tyler Technologies account representative.
For Civagent configuration and deployment, contact the Civagent team for jurisdiction setup and API endpoint configuration.
For Socrata open data portal questions, refer to the Tyler Data & Insights division documentation at dev.socrata.com.