Log inStart free trial

Cliniko Support API: Watch Ended Appointments, Archive a Contact

Practice management for healthcare providers — appointments, notes, and billing. 6 triggers, 17 searches, and 16 actions including Watch Ended Appointments.

About this integration

Practice management for healthcare providers — appointments, notes, and billing.

There are 6 triggers, 17 search modules and 16 actions available. The integration connects via basic authentication.

How to connect

The credential form asks for API Key.

Prefer the interactive builder form? Open it on the app page.

Paste your credentials once — WEXTL® stores them encrypted and reuses the connection across every workflow that needs it.

Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.

Connecting Cliniko to WEXTL®

Connecting Cliniko to WEXTL®

Field	Type	Help
API KeyRequired	text	API key you've created for your account. API Key can be created under `Settings` -> `Integrations`.

Use it in workflow automation

Start with Watch Ended Appointments, then add Archive a Contact.

The canvas below runs Watch Ended Appointments into Archive a Contact — watch the video, then drop a node onto the canvas.

Select the Watch Ended Appointments trigger and the workflow fires automatically when the event occurs — no polling required.

Then add Create an Individual Appointment as the next node. Branch, filter, or hand off to other integrations from there.

The integration includes 22 ready-made modules for support work — each run logs its inputs and outputs for debugging.

Cliniko workflow on the canvas: Watch Ended Appointments then Create an Individual Appointment

Cliniko workflow on the canvas: Watch Ended Appointments then Create an Individual Appointment

Triggers, searches and actions

Open any Cliniko trigger, search, or action to see its inputs and outputs — 6 triggers, 17 searchs, 16 actions.

Triggers

Use one of 6 triggers to kick off a workflow as soon as an event occurs in the app.

Watch Ended Appointments
Watch New Appointments
Watch New Contacts
Watch New Invoices
Watch New Patients

1more trigger

Searches

This integration includes 17 search modules for looking data up mid-run.

Get a Booking
Get a Contact
Get an Individual Apppointment
Get an Invoice
Get an Invoice Item

12more searches

Actions

Take action during a run with 16 available modules that write data back into the app.

Archive a Contact
Archive an Individual Appointment
Archive a Patient
Archive a Product
Cancel an Individual Appointment

11more actions

Explore the fields available for each Cliniko trigger, search, and action.

Triggers

Output fields

Field	Type
Booking ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Output fields

Field	Type
Booking ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Output fields

Field	Type
Invoice ID	text
Discounted Amount	text
Invoice To	text
Issue Date	text
Net Amount	text
Notes	text
Number	number
Online Payment Url	text
Patient Extra Information	text
Tax Amount	text
Total Amount	text
Closed at	date
Status	number
Status Description	text
Appointment	object
Links	object
Business	object
Links	object
Practitioner	object
Links	object
Patient	object
Links	object
Invoice Items	object
Links	object
Links	object
Self	text

4other output fields

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

32other output fields

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Searches

Input fields

Field	Type
Booking IDRequired	text

Output fields

Field	Type
Booking ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
Contact IDRequired	text

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Input fields

Field	Type
Individual Appointment IDRequired	text

Output fields

Field	Type
Individual Appointment ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
Invoice IDRequired	text

Output fields

Field	Type
Invoice ID	text
Discounted Amount	text
Invoice To	text
Issue Date	text
Net Amount	text
Notes	text
Number	number
Online Payment URL	text
Patient Extra Information	text
Tax Amount	text
Total Amount	text
Closed at	date
Status	number
Status Description	text
Appointment	object
Links	object
Business	object
Links	object
Practitioner	object
Links	object
Patient	object
Links	object
Invoice Items	object
Links	object
Links	object
Self	text

4other output fields

Input fields

Field	Type
Invoice Item IDRequired	text

Output fields

Field	Type
Invoice Item ID	text
Concession Type Name	text
Discount Percentage	text
Discounted Amount	text
Is Monetary Discount	boolean
Name	text
NET Price	text
Quantity	number
Tax Name	text
Tax Rate	text
Unit Price	text
Code	text
Tax Amount	text
Total Including Tax	text
Billable Item	object
Links	object
Invoice	object
Links	object
Links	object
Self	text
Created at	date
Deleted at	text
Updated at	date

1other output field

Input fields

Field	Type
Patient IDRequired	text

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

32other output fields

Input fields

Field	Type
Practitioner IDRequired	text

Output fields

Field	Type
Practitioner ID	number
Created at	date
Updated at	date
Active	boolean
Designation	text
Description	text
Display Name	text
First Name	text
Last Name	text
Show in Online Bookings	boolean
Title	text
Label	text
Default Appointment Type	object
Links	object
User	object
Links	object
Appointments	object
Links	object
Appointment Types	object
Links	object
Invoices	object
Links	object
Practitioner Reference Numbers	object
Links	object
Links	object
Self	text

Input fields

Field	Type
Product IDRequired	text

Output fields

Field	Type
Product ID	text
Item Code	text
Name	text
Product Supplier Name	text
Price Ex Tax	text
Cost Price	text
Stock Level	number
Notes	text
Serial Number	text
Price Including Tax	text
Product Supplier	object
Links	object
Tax	object
Links	object
Links	object
Self	text
Created at	date
Updated at	date

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Booking ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Booking ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
Invoice IDRequired	text
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Invoice Item ID	text
Concession Type Name	text
Discount Percentage	text
Discounted Amount	text
Is Monetary Discount	boolean
Name	text
NET Price	text
Quantity	number
Tax Name	text
Tax Rate	text
Unit Price	text
Code	text
Tax Amount	text
Total Including Tax	text
Billable Item	object
Links	object
Invoice	object
Links	object
Links	object
Self	text
Created at	date
Deleted at	text
Updated at	date

1other output field

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Invoice ID	text
Discounted Amount	text
Invoice To	text
Issue Date	text
Net Amount	text
Notes	text
Number	number
Online Payment Url	text
Patient Extra Information	text
Tax Amount	text
Total Amount	text
Closed at	date
Status	number
Status Description	text
Appointment	object
Links	object
Business	object
Links	object
Practitioner	object
Links	object
Patient	object
Links	object
Invoice Items	object
Links	object
Links	object
Self	text

4other output fields

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

32other output fields

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Practitioner ID	text
Active	boolean
Designation	text
Description	text
Display Name	text
First Name	text
Last Name	text
Show in Online Bookings	boolean
Title	text
Label	text
User	object
Links	object
Appointments	object
Links	object
Appointment Types	object
Links	object
Invoices	object
Links	object
Practitioner Reference Numbers	object
Links	object
Links	object
Self	text
Created at	date
Updated at	date

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Product ID	text
Item Code	text
Name	text
Product Supplier Name	text
Price Ex Tax	text
Cost Price	text
Stock Level	number
Notes	text
Serial Number	text
Price Including Tax	text
Product Supplier	object
Links	object
Tax	object
Links	object
Links	object
Self	text
Created at	date
Updated at	date

Input fields

Field	Type
Search criteria	text
Sort	array
SortRequired	choice
Limit	number

Output fields

Field	Type
Archived At	date
Attendee	object
Links	object
Author Name	text
Booking	object
Links	object
Content	object
Sections	array
Created At	date
Deleted At	date
Draft	boolean
Finalized At	date
ID	text
Links	object
Self	text
Patient	object
Links	object
Pinned At	date
Practitioner	object
Links	object
Title	text
Treatment Note Template	object
Links	object
Updated At	date

Actions

Input fields

Field	Type
Patient IDRequired	text

Input fields

Field	Type
Individual Appointment IDRequired	text

Input fields

Field	Type
Patient IDRequired	text

Input fields

Field	Type
Product IDRequired	text

Input fields

Field	Type
Individual Appointment IDRequired	text
Cancellation ReasonRequired	choice
Apply to Repeats	boolean
Cancellation Note	text

Input fields

Field	Type
First NameRequired	text
Last NameRequired	text
Email	email
Phone Numbers	array
Address 1	text
Address 2	text
City	text
State	text
Post Code	text
Country Code	text
Occupation	text
Notes	text
Preferred Name	text
Company Name	text
Doctor Type	choice
Provider Number	text
Title	text
Type Code	choice

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Input fields

Field	Type
Practitioner IDRequired	text
Patient IDRequired	text
Appointment Type IDRequired	choice
Starts atRequired	date
Ends atRequired	date
Business IDRequired	choice
Notes	text
Patient Case ID	text
Repeat Rule	object
Number of Repeats	number
Repeat Type	choice
Repeating Interval	number

Output fields

Field	Type
Individual Appointment ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
First NameRequired	text
Last NameRequired	text
PronounsRequired	object
AccusativeRequired	text
NominativeRequired	text
Predicative PossessiveRequired	text
Pronominal PossessiveRequired	text
ReflexiveRequired	text
Date Of Birth	date
Gender Identity	text
Address 1	text
Address 2	text
Address 3	text
City	text
State	text
Post Code	text
Country	text
Email	text
Emergency Contact	text
Medicare	text
Medicare Reference Number	text
Dva Card Number	text
Occupation	text
Referral Source	text
Reminder Type	text

22other input fields

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

31other output fields

Input fields

Field	Type
Item Code	text
Name	text
Serial Number	text
Price	number
Product Supplier Name	text
Price Includes Tax	boolean
Stock Level	number
Tax ID	choice
Cost Price	text
Notes	text

Output fields

Field	Type
Product ID	text
Item Code	text
Name	text
Product Supplier Name	text
Price Ex Tax	text
Cost Price	text
Stock Level	number
Notes	text
Serial Number	text
Price Including Tax	text
Product Supplier	object
Links	object
Tax	object
Links	object
Links	object
Self	text
Created at	date
Updated at	date

Input fields

Field	Type
Product IDRequired	text
QuantityRequired	number
Adjustment TypeRequired	choice
Comment	text

Output fields

Field	Type
Stock Adjustment ID	text
Quantity	number
Adjustment Type	text
Comment	text
User	object
Links	object
Product	object
Links	object
Links	object
Self	text

Input fields

Field	Type
MethodRequired	choice
Headers	array
Key	text
Value	text
Query String	array
Key	text
Value	text
Body	text

Output fields

Field	Type
Body	text
Headers	object
Status code	number

Input fields

Field	Type
Patient IDRequired	text

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

32other output fields

Input fields

Field	Type
Contact IDRequired	text
First Name	text
Last Name	text
Email	email
Phone Numbers	array
Address 1	text
Address 2	text
City	text
State	text
Post Code	text
Country Code	text
Occupation	text
Notes	text
Preferred Name	text
Company Name	text
Doctor Type	choice
Provider Number	text
Title	text
Type Code	choice

Output fields

Field	Type
Contact ID	number
Address 1	text
Address 2	text
Address 3	text
City	text
Company Name	text
Country Code	text
Doctor Type	text
Email	email
First Name	text
Last Name	text
Notes	text
Occupation	text
Phone Numbers	array
Post Code	text
Preferred Name	text
Provider Number	text
State	text
Title	text
Country	text

7other output fields

Input fields

Field	Type
Individual Appointment IDRequired	text
Practitioner ID	text
Patient ID	text
Appointment Type ID	choice
Starts at	date
Ends at	date
Business ID	choice
Notes	text
Patient Case ID	text
Repeat Rule	object
Number of Repeats	number
Repeat Type	choice
Repeating Interval	number

Output fields

Field	Type
Individual Appointment ID	text
Ends at	date
Booking IP Address	text
Cancellation Note	text
Cancellation Reason	text
Cancellation Reason Description	text
Conflicts	object
Links	object
Did Not Arrive	boolean
Email Reminder Sent	boolean
Notes	text
Online Booking Policy Accepted	text
Patient Arrived	boolean
Has Patient Appointment Notes	boolean
Patient Name	text
Repeat Rule	object
Repeats	text
SMS Reminder Sent	boolean
Telehealth URL	url
Treatment Note Status	text
Cancelled at	date

12other output fields

Input fields

Field	Type
Patient IDRequired	text
First Name	text
Last Name	text
Pronouns	object
Accusative	text
Nominative	text
Predicative Possessive	text
Pronominal Possessive	text
Reflexive	text
Date Of Birth	date
Gender Identity	text
Address 1	text
Address 2	text
Address 3	text
City	text
State	text
Post Code	text
Country	text
Email	text
Emergency Contact	text
Medicare	text
Medicare Reference Number	text
Dva Card Number	text
Occupation	text
Referral Source	text

19other input fields

Output fields

Field	Type
Patient ID	number
Created at	date
Updated at	date
Accepted Email Marketing	boolean
Accepted Privacy Policy	boolean
Accepted SMS Marketing	boolean
Address 1	text
Address 2	text
Address 3	text
Appointment Notes	text
City	text
Country	text
Date of Birth	text
DVA Card Number	text
Email	email
Emergency Contact	text
First Name	text
Gender Identity	text
Invoice Default to	text
Invoice Email	email

31other output fields

Input fields

Field	Type
Product IDRequired	text
Item Code	text
Name	text
Serial Number	text
Price	number
Product Supplier Name	text
Price Includes Tax	boolean
Tax ID	choice
Cost Price	text
Notes	text

Output fields

Field	Type
Product ID	text
Item Code	text
Name	text
Product Supplier Name	text
Price Ex Tax	text
Cost Price	text
Stock Level	number
Notes	text
Serial Number	text
Price Including Tax	text
Product Supplier	object
Links	object
Tax	object
Links	object
Links	object
Self	text
Created at	date
Updated at	date