Register a webhook endpoint to receive event notifications.

Registers a callback URL that will receive real-time event notifications for work orders, invoices, item categories, and leads.

Once registered, FieldEdge will POST a JSON payload to your callback URL whenever a supported event occurs.

Important: Events Are Notification-Only

Webhook events are notification-only. Each event contains the identifier of the affected entity and the type of change that occurred, but does not contain the entity's data. To act on an event, consumers must call the corresponding GET endpoint using their scoped API credentials.

Webhook Payload Envelope

Every event is delivered in the following standard envelope:

{
  "id": "<event-uuid>",
  "companyId": "<company-guid>",
  "source": "<producing-service>",
  "type": "<entity>.<action>",
  "time": "<RFC 3339 UTC timestamp>",
  "datacontenttype": "application/json",
  "data": {
    "<entityId>": "<uuid>",
    "<entityNumber>": "<business-identifier>",
    "metadata": {
      "...": "optional free-form key/value context"
    }
  }
}

Each delivery also includes the header X-FieldEdge-Signature: sha256=<hex> computed from the payload body using your HMAC secret. Validate this header to confirm the request originated from FieldEdge.

Work Orders — `source: "work-orders"`

`type`	Description
`workorder.created`	A new work order was created
`workorder.scheduled`	A work order was scheduled
`workorder.unscheduled`	A work order was removed from the schedule
`workorder.traveling`	Technician is traveling to the work order site
`workorder.complete`	Work order was completed
`workorder.canceled`	Work order was canceled
`workorder.backorder`	Work order placed on backorder
`workorder.finalized`	Work order was finalized

Example payload:

{
  "id": "5759473c-02ff-4ed5-a234-35af7a362c46",
  "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source": "work-orders",
  "type": "workorder.created",
  "time": "2026-05-12T14:20:40.654524Z",
  "datacontenttype": "application/json",
  "data": {
    "workOrderId": "b2e0fc82-f56c-4064-a99e-dedaa6c113b4",
    "workOrderNumber": "2174"
  }
}

Invoices — `source: "invoice"`

`type`	Description
`invoice.created`	A new invoice was created
`invoice.updated`	An existing invoice was updated

Example payload:

{
  "id": "3dd89180-dbe9-4438-92a4-965f770c5bf9",
  "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source": "invoice",
  "type": "invoice.created",
  "time": "2026-05-12T14:10:32.963514Z",
  "datacontenttype": "application/json",
  "data": {
    "invoiceId": "244a8e11-69b8-4f23-9f84-44e741bd7b7b",
    "invoiceNumber": "i50188"
  }
}

Item Categories — `source: "item-categories"`

`type`	Description
`item-category.created`	A new item category was created
`item-category.updated`	An existing item category was updated

Example payload:

{
  "id": "7c3a1e9f-4b82-4d61-bc2e-9f1a2b3c4d5e",
  "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source": "item-categories",
  "type": "item-category.created",
  "time": "2026-05-20T10:30:00.000000Z",
  "datacontenttype": "application/json",
  "data": {
    "categoryId": "f4e3d2c1-b0a9-4876-8765-543210fedcba"
  }
}

Leads / CRM — `source: "crm"`

`type`	Description
`lead.offered`	A lead was offered to the partner
`lead.accepted`	Partner accepted the lead
`lead.rejected`	Partner rejected the lead
`lead.customer_linked`	A lead was linked to a customer record
`job.created`	A job was created from a lead
`job.linked`	A job was linked to a lead
`job.scheduled`	A job was scheduled
`job.canceled`	A job was canceled
`job.traveling`	Technician is traveling to the job site
`job.started`	Job work was started
`job.paused`	Job was paused
`job.completed`	Job was completed
`job.finalized`	Job was finalized
`quote.accepted`	A quote was accepted
`quote.rejected`	A quote was rejected
`quote.expired`	A quote expired

Example payload:

{
  "id": "9f1c4e2a-7b88-4a1c-9c2e-2b3d4e5f6a7b",
  "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source": "crm",
  "type": "lead.customer_linked",
  "time": "2026-05-12T14:25:11.123456Z",
  "datacontenttype": "application/json",
  "data": {
    "leadId": "d3e118a4-b714-4055-9707-4efcb17c6f74",
    "metadata": {
      "campaign": "Summer Sale",
      "referralSource": "Google Ads"
    }
  }
}

Required scope: webhooks:write

Register a webhook endpoint to receive event notifications.

Important: Events Are Notification-Only

Webhook Payload Envelope

Work Orders — `source: "work-orders"`

Invoices — `source: "invoice"`

Item Categories — `source: "item-categories"`

Leads / CRM — `source: "crm"`

Request

Responses

Register a webhook endpoint to receive event notifications.

Important: Events Are Notification-Only#

Webhook Payload Envelope#

Work Orders — source: "work-orders"#

Invoices — source: "invoice"#

Item Categories — source: "item-categories"#

Leads / CRM — source: "crm"#

Request

Responses

Important: Events Are Notification-Only

Webhook Payload Envelope

Work Orders — `source: "work-orders"`

Invoices — `source: "invoice"`

Item Categories — `source: "item-categories"`

Leads / CRM — `source: "crm"`