Skip to main content
POST
Create audit event

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
type
string
required

Event type code (e.g. rest, login, export)

Maximum string length: 200
recorded
string
required

ISO 8601 timestamp

Maximum string length: 50
agent
object[]
required
Required array length: 1 - 20 elements
source
object
required
subtype
string[]
Maximum array length: 10
Maximum string length: 200
action
string

C, R, U, D, E

Maximum string length: 10
outcome
string

0=success, 4=minor, 8=serious, 12=major

Maximum string length: 10
outcomeDesc
string
Maximum string length: 2000
purposeOfEvent
string[]
Maximum array length: 10
Maximum string length: 200
entity
object[]
Maximum array length: 20

Response

201

Audit event created