Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
MessagesAttachmentsContacts
Work OrdersCommunication

Messages

Communicate with providers via work order messages.


Messages

Communicate with the provider via work order messages. Messages are visible to specified groups and create a communication history.

List Messages

GET /workorders/{id}/messages

Response

{
  "results": [
    {
      "msg_id": "1001",
      "from": {
        "id": 12345,
        "name": "John Smith",
        "role": "provider"
      },
      "message": "On my way to the site now.",
      "role": "ASSIGNEDTECH",
      "read": true,
      "created": { "utc": "2025-01-15 08:30:00" }
    },
    {
      "msg_id": "1002",
      "from": {
        "id": 500,
        "name": "Dispatch Team",
        "role": "buyer"
      },
      "message": "Please use the side entrance.",
      "role": "ASSIGNEDTECH",
      "read": false,
      "created": { "utc": "2025-01-15 08:00:00" }
    }
  ]
}

Send Message

POST /workorders/{id}/messages

{
  "message": "Please use the side entrance.",
  "type": "ASSIGNEDTECH"
}

Reply to Message

POST /workorders/{id}/messages/{message_id}

{
  "message": "Understood, heading there now."
}

Message Types

Control message visibility and recipients using the type field:

TypeDescription
INTERNALInternal team only (Staff Note)
ASSIGNEDTECHSend to assigned provider
REQUESTEDTECHSSend to all requested providers
SPECIFICTECHSend to specific provider (use to.id)
ROUTEDTECHSSend to all routed providers
REPLYReply to a message
REPLYTOTHREADReply to a message thread
TECHTOMANAGERProvider to manager communication
STAFF_NOTEInternal staff note
{
  "message": "Equipment is in the back room.",
  "type": "ASSIGNEDTECH"
}
{
  "message": "Provider seems inexperienced, monitor closely.",
  "type": "INTERNAL"
}

INTERNAL and STAFF_NOTE messages are only visible to your internal team, not to the provider.

Message Notifications

Messages trigger notifications to relevant parties:

  • Push notifications to mobile app
  • Email notifications (based on preferences)
  • In-app alerts on work order

Related

  • Attachments - File sharing
  • Contacts - Site contact info

Last updated on

Discounts & Increases

Managing buyer discounts and pay increases on work orders.

Attachments

Upload and manage files on work orders.

On this page

Messages
List Messages
Response
Send Message
Reply to Message
Message Types
Message Notifications
Related