Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuickstartAPI Playground

Documentation

Support

Migration Guide

Introduction

Real-time event notifications from Field Nation to your system. Build reactive integrations that respond instantly to work order changes.


What Are Webhooks?

Webhooks are server-to-server HTTP callbacks that notify your system when specific events happen in Field Nation. Think of them as "reverse API calls" – instead of your system asking Field Nation for updates, Field Nation pushes updates to you.

Loading diagram...

How They Work

  1. Subscribe - Register your HTTPS endpoint and select events to receive
  2. Event Occurs - A work order is created, updated, or status changes
  3. Notification Sent - Field Nation POSTs event payload to your endpoint
  4. Process & Respond - Your system processes the event and returns 200 OK
  5. Automatic Retry - If delivery fails, Field Nation retries with exponential backoff

Why Use Webhooks?

Real-Time Synchronization

Receive updates within seconds of events occurring. Keep your systems in sync without polling delays.

Reduced API Load

Eliminate constant polling. Webhooks push data only when something changes, reducing API calls by 95%+.

Event-Driven Architecture

Build reactive workflows that trigger automatically. Assign providers, update ERP systems, send notificationsβ€”all in real-time.

Cost Efficient

Lower infrastructure costs. No need to run continuous polling jobs or maintain complex scheduling logic.


Common Use Cases

1. Work Order Lifecycle Automation

Automatically respond to work order status changes:

  • Published β†’ Auto-assign to preferred provider
  • Assigned β†’ Update dispatch board, notify technician
  • Checked In β†’ Log start time in ERP system
  • Work Done β†’ Trigger approval workflow
  • Approved β†’ Generate invoice, update accounting system

2. Real-Time Notifications

Keep stakeholders informed instantly:

  • Notify clients when work orders are completed
  • Alert managers when providers decline assignments
  • Send SMS/email when work is approved
  • Update dashboards in real-time

3. Data Synchronization

Maintain consistent data across systems:

  • Sync work order details to Salesforce, ServiceNow, or NetSuite
  • Update custom dashboards and reporting tools
  • Mirror Field Nation data in your database
  • Replicate changes to multiple downstream systems

4. Compliance & Auditing

Track every change for regulatory requirements:

  • Log all status transitions with timestamps
  • Record who approved, declined, or modified work orders
  • Maintain audit trails for compliance reporting
  • Alert on specific event patterns

When to Use Webhooks vs REST API

ScenarioUse WebhooksUse REST API
Real-time updatesβœ… Ideal❌ Requires polling
Event-driven workflowsβœ… Perfect fit⚠️ Complex to implement
Creating work orders❌ Not supportedβœ… Use POST requests
Bulk data queries❌ Not designed for thisβœ… Use GET endpoints
On-demand data retrieval❌ Event-based onlyβœ… Query anytime
Reducing API callsβœ… Push notifications❌ Constant polling

Best Practice: Use webhooks for event-driven updates and REST API for on-demand queries and write operations. Most integrations use both together.


Available Events

Field Nation Webhooks support 33 distinct events covering the complete work order lifecycle:

Event Categories

  • workorder.created - New work order created
  • workorder.routed - Routed to specific provider(s)
  • workorder.requested - Provider requested assignment
  • workorder.declined - Provider declined assignment
  • workorder.undeclined - Decline reversed
  • workorder.status.published - Work order published to marketplace
  • workorder.status.assigned - Provider assigned to work order
  • workorder.status.on_my_way - Provider en route
  • workorder.status.checked_in - Provider arrived on site
  • workorder.status.work_done - Work completed
  • workorder.status.approved - Work approved by buyer
  • And 14 more status changes...
  • workorder.message_posted - New message or reply
  • workorder.provider_upload - Document uploaded
  • workorder.task_completed - Task marked complete
  • workorder.schedule_updated - Schedule changed
  • workorder.tag_added / tag_removed - Tags modified

View complete event catalog β†’


Key Features

πŸ”’ Secure Delivery

  • HMAC-SHA256 signatures - Verify webhook authenticity
  • Custom headers - Pass authentication tokens
  • IP whitelisting - Restrict to Field Nation IPs
  • HTTPS required - Encrypted transmission

Learn about security β†’

πŸ” Automatic Retries

  • Exponential backoff - 10s, 20s, 40s, 80s, 160s, 320s, 640s
  • Up to 7 attempts - Based on delivery success rate
  • Manual retry - Reprocess failed deliveries via API
  • Dead letter queue - Access failed events for debugging

Understanding delivery β†’

πŸ“Š Comprehensive Monitoring

  • Delivery logs - Every attempt recorded
  • Pre-signed log URLs - Access complete request/response
  • Filtering & search - Find deliveries by event, status, work order
  • Change history - Audit trail of webhook modifications

Monitoring webhooks β†’

πŸ› οΈ Flexible Management

  • Web UI - Visual webhook configuration dashboard
  • REST API - Programmatic webhook management
  • Multiple webhooks - Different endpoints per event type
  • Status control - Active, inactive, or archived

Creating webhooks β†’


Prerequisites

Before working with webhooks, ensure you have:

Field Nation Account Access

  • Buyer account with active contract
  • API credentials (client_id and client_secret)
  • Webhook access enabled (contact support if needed)

Technical Requirements

  • HTTPS endpoint - Publicly accessible URL
  • Response within 5 seconds - Acknowledge deliveries quickly
  • 2xx status code - Indicate successful receipt

Development Tools (Optional)

  • ngrok or localtunnel - For local testing
  • Request inspection tools - webhook.site, request.bin
  • Monitoring setup - Logs, alerts, dashboards

Complete prerequisites guide β†’


Getting Started

Ready to receive your first webhook?

15-Minute Quickstart

Create your first webhook and receive events in under 15 minutes

Core Concepts

Understand events, payloads, and delivery mechanics

Security Best Practices

Verify signatures and secure your webhook endpoint

API Reference

Complete API documentation for programmatic management


Need Help?

Support Resources

  • Technical Issues: Submit a support case
  • Email: integrations-engineering@fieldnation.com
  • API Playground: Swagger UI (Sandbox)

Last updated on

Quickstart

Create your first webhook and receive Field Nation events in under 15 minutes. Step-by-step guide from setup to testing.

On this page

What Are Webhooks?
How They Work
Why Use Webhooks?
Common Use Cases
1. Work Order Lifecycle Automation
2. Real-Time Notifications
3. Data Synchronization
4. Compliance & Auditing
When to Use Webhooks vs REST API
Available Events
Event Categories
Key Features
πŸ”’ Secure Delivery
πŸ” Automatic Retries
πŸ“Š Comprehensive Monitoring
πŸ› οΈ Flexible Management
Prerequisites
Field Nation Account Access
Technical Requirements
Development Tools (Optional)
Getting Started
Need Help?