IncidentsReport an incident

Report an incident

Needs: Incidents, Read-write

Reports an incident as the Report incident form does, reported by the organisation owner. A normal incident starts in Triage. Use the edit endpoint afterwards to change its status or assign it. Use POST /site-incidents for a site incident.

Errors

  • 422 with Unknown custom attributes: ... for a key that is not in the options.
  • 422 with Required on the report form: ... when a required attribute is missing.
curl -X POST "https://app.imploy.com.au/api/integrations/v1/incidents" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "title": "Fall in the kitchen",
  "description": "<p>Client slipped on a wet floor.</p>",
  "priority": "Medium",
  "category": "Injury",
  "location": "Kitchen"
}'
{
  "created": 12,
  "kind": "incident",
  "code": "INC-012",
  "status": "Triage"
}
POST
/incidents
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Content-Typestring
Required

The media type of the request body

Options: application/json
titlestring
Required

The incident title.

descriptionstring

What happened. Plain text or simple HTML.

prioritystring

One of Low, Medium or High.

categorystring

One of Medication, Behaviour, Injury, Abuse, Restrictive, Privacy or Other.

locationstring

Where it happened.

shift_idinteger

The shift it happened on (a site shift for a site incident). Links the client or clients and staff.

custom_attributesobject

Key and value pairs for any attribute from the options endpoint. Use lists for multiselect and checklist. Attributes marked required on the create form must be sent.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Body

application/json
titlestring
Required

The incident title.

descriptionstring

What happened. Plain text or simple HTML.

prioritystring

One of Low, Medium or High.

categorystring

One of Medication, Behaviour, Injury, Abuse, Restrictive, Privacy or Other.

locationstring

Where it happened.

shift_idinteger

The shift it happened on (a site shift for a site incident). Links the client or clients and staff.

custom_attributesobject

Key and value pairs for any attribute from the options endpoint. Use lists for multiselect and checklist. Attributes marked required on the create form must be sent.

Responses