Skip to main content
WEBHOOK

​
When it’s sent

  • A treatment is added to a patient’s chart. Only treatments linked to a procedure from the price list are sent.
The request type is NEW_OPERATION. See the introduction to subscribe to this event and verify the X-Hub-Signature-256 signature.

Headers

​
X-Hub-Signature-256
string

HMAC SHA-256 of the raw request body, keyed with your Verify Token, as sha256=<hex>. Sent only when a Verify Token is set.

Example:

"sha256=3f1c5e…"

Body

application/json

Sent when a treatment (operation) is added to a patient.

​
version
enum<string>
required

Payload version.

Available options:
v1.0
Example:

"v1.0"

​
type
enum<string>
required

Event type.

Available options:
NEW_OPERATION
Example:

"NEW_OPERATION"

​
id
string

Operation ID.

Example:

"ckx1o0000001"

​
quantity
number

Quantity.

Example:

1

​
price
number | null

Price.

Example:

500

​
name
string | null

Treatment name.

Example:

"Composite filling"

​
code
string | null

Procedure code.

Example:

"D2391"

​
tooth
integer[]

Tooth numbers.

Example:
​
service_id
string

Procedure ID from the price list.

Example:

"ckx1s0000001"

​
patient_id
string

Patient ID.

Example:

"ckx1p0000001"

​
operator_id
string

Doctor (user) ID.

Example:

"ckx1u0000001"

​
patient_data
object

Basic patient details. Empty object {} when there is no patient.

​
branch_data
object

Branch.

Example:

Response

200

Return any 2xx status within 5 seconds to acknowledge the event. Failed deliveries are not retried.