addEventByClientRef

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/jobs/{id}/events in the new API; the migration guide has the recommended order of work and the important model differences.

The new endpoint addresses jobs by numeric id only — legacy clientRef lookup is gone. Resolve the clientRef first, then post the event.

sequenceDiagram
    autonumber
    participant Client
    participant API as Oneserve API
    Client->>API: GET /v1/jobs?clientRef=ABC-123
    API-->>Client: [{id: jobId, ...}]
    Client->>API: POST /v1/jobs/{jobId}/events<br/>{date, notes, eventType}
    API-->>Client: 201 Created

Cache the valid eventType codes from GET /v1/jobs/job-events rather than fetching per call.

Open POST /v1/jobs/{id}/events in the new API →

View legacy reference

/rest/workflow/job/addEventByClientRef

POST 

Adds a Job Event.  Looks up job by Job Ref if not blank, otherwise by Job Client Ref and Client ID.

acceptable request representations:

• application/json

{
  "jobRef":"",
  "jobClientRef":"jfjn38",
  "clientId":"34",
  "sigEventCode":"AB",
  "appointmentId":"343",
  "noteId":"33",
  "note":"a note",
  "date":"12-12-2012 12:34"
}

See the Workflow API matrix for the full list of endpoints in this category.