Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuickstartAPI Playground

Documentation

Webhook EventsPayload StructureDelivery MechanicsWebhook Lifecycle

Support

Migration Guide
Core Concepts

Webhook Events

Complete catalog of all 33 webhook events covering the work order lifecycle, status changes, and activity events.


Event Categories

Events are organized into three main categories. Select a category to explore available events.

Lifecycle Events

13 events - Core work order actions like creation, routing, assignment, and completion.

Status Changes

19 events - Work order status transitions (draft, published, assigned, approved, paid, etc.)

Activity Events

Overlaps with lifecycle - Messages, uploads, task updates, schedule changes, and tags.


Complete Event Catalog

Lifecycle Events

These events track the primary actions in a work order's journey.

Status Change Events

These events fire when a work order transitions between statuses.


Event Filtering

When creating a webhook, you can subscribe to specific events to reduce noise.

Configuration Examples

Subscribe to everything for full synchronization.

{
  "events": [
    "workorder.created",
    "workorder.routed",
    // ... all 33 events
  ]
}

Focus on the operational flow.

{
  "events": [
    "workorder.created",
    "workorder.routed",
    "workorder.requested",
    "workorder.declined",
    "workorder.task_completed"
  ]
}

Perfect for minimal status updates.

{
  "events": [
    "workorder.status.published",
    "workorder.status.assigned",
    "workorder.status.checked_in",
    "workorder.status.work_done",
    "workorder.status.approved",
    "workorder.status.paid"
  ]
}

Minimal integration for high-value signals.

{
  "events": [
    "workorder.status.published",    // Work order available
    "workorder.status.assigned",     // Provider assigned
    "workorder.status.work_done",    // Work completed
    "workorder.status.approved"      // Ready for payment
  ]
}

Best Practices

Start Small, Expand Later

Begin with Core Events

Subscribe to 4-6 critical events initially:

  • workorder.created
  • workorder.status.assigned
  • workorder.status.work_done
  • workorder.status.approved

Test Thoroughly

Verify your system handles events correctly before adding more.

Add Events Incrementally

Expand to additional events as you build new features.

Filter Strategically

Don't subscribe to events you won't use.

StrategyDescriptionImpact
❌ BadSubscribe to all 33 events "just in case"Increases processing overhead and log volume.
✅ GoodSubscribe only to events your system processesCleaner logs, less noise, lower server load.

Document Your Event Handling

Maintain internal documentation mapping events to your handlers:

EventHandlerPurpose
workorder.status.publishedpublishHandler()Notify provider network
workorder.status.assignedassignHandler()Update dispatch board
workorder.status.work_donecompleteHandler()Trigger approval flow

Last updated on

API Playground

Jump to the Webhooks v3 playground to explore requests and responses.

Payload Structure

Understanding webhook payloads - standard fields, work order data, headers, and how to parse webhook requests.

On this page

Event Categories
Complete Event Catalog
Lifecycle Events
Status Change Events
Event Filtering
Configuration Examples
Best Practices
Start Small, Expand Later
Begin with Core Events
Test Thoroughly
Add Events Incrementally
Filter Strategically
Document Your Event Handling