Connectors Reference

10to8 Appointment Scheduling

10to8 is a powerful appointment management, communications & online booking system.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GetOrganisations ()

Get organisations

BookAppointment (string organisation-id, BookAppointmentParameterBody body)

Book new appointment

 

Triggers:

Name

Summary

GetAppointments (string organisation-id)

When a booking is made

GetCustomers (string organisation-id)

When a new customer is added

GetInboxIncomingMessagesAppeared (string organisation-id)

When an incoming message appears in your inbox

GetInboxIncomingMessagesDisappeared (string organisation-id)

When an incoming message disappears from your inbox

GetInboxBookingRequestAppeared (string organisation-id)

When a booking request appears in your inbox

GetInboxBookingRequestDisappeared (string organisation-id)

When a booking request disappears from your inbox

GetInboxChangeCancellationRequestAppeared (string organisation-id)

When a change or cancellation request appears in your inbox

GetInboxChangeCancellationRequestDisappeared (string organisation-id)

When a change or cancellation request disappears from your inbox

 

Objects:

Name

Summary

BookAppointmentParameterBody

 

EventProposal

 

GetAppointmentsResponseItem

 

GetCustomersResponseItem

 

GetOrganisationsResponseItem

 

IncomingMessage

 

 

Actions:

GetOrganisations

Summary: Get organisations

Description: Returns a list of all organisations for the authorized account.

 

Syntax:

10to8AppointmentScheduling.GetOrganisations ()

 

Returns:

          Type:array of (GetOrganisationsResponseItem)

 

BookAppointment

Summary: Book new appointment

Description: Book a new appointment in 10to8.

 

Syntax:

10to8AppointmentScheduling.BookAppointment (string organisation-id, BookAppointmentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

body

BookAppointmentParameterBody

 

Details for a new appointment

True

 

Returns:

          Type:string

 

Triggers:

Trigger GetAppointments

Summary: When a booking is made

Description: Triggers when a new booking is made in 10to8.

 

Syntax:

10to8AppointmentScheduling.GetAppointments (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (GetAppointmentsResponseItem)

 

Trigger GetCustomers

Summary: When a new customer is added

Description: Triggers when a new customer is added in 10to8.

 

Syntax:

10to8AppointmentScheduling.GetCustomers (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (GetCustomersResponseItem)

 

Trigger GetInboxIncomingMessagesAppeared

Summary: When an incoming message appears in your inbox

Description: Triggers when an incoming message appears in your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxIncomingMessagesAppeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (IncomingMessage)

 

Trigger GetInboxIncomingMessagesDisappeared

Summary: When an incoming message disappears from your inbox

Description: Triggers when an incoming message disappears from your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxIncomingMessagesDisappeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (IncomingMessage)

 

Trigger GetInboxBookingRequestAppeared

Summary: When a booking request appears in your inbox

Description: Triggers when a booking request appears in your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxBookingRequestAppeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (EventProposal)

 

Trigger GetInboxBookingRequestDisappeared

Summary: When a booking request disappears from your inbox

Description: Triggers when a booking request disappears from your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxBookingRequestDisappeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (EventProposal)

 

Trigger GetInboxChangeCancellationRequestAppeared

Summary: When a change or cancellation request appears in your inbox

Description: Triggers when a change or cancellation request appears in your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxChangeCancellationRequestAppeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (EventProposal)

 

Trigger GetInboxChangeCancellationRequestDisappeared

Summary: When a change or cancellation request disappears from your inbox

Description: Triggers when a change or cancellation request disappears from your inbox.

 

Syntax:

10to8AppointmentScheduling.GetInboxChangeCancellationRequestDisappeared (string organisation-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

organisation-id

string

(Organisation Id)

Pick your organisation.

True

GetOrganisations

 

Returns:

          Type:array of (EventProposal)

 


 

BookAppointmentParameterBody

Summary:

Description: Details for a new appointment

 

          Properties:

Name

Type

Summary

start

string(date-time)

Start Date-Time

(UTC format) yyyy-MM-ddTHH:mm:ss.fffZ

end

string(date-time)

End Date-Time

(UTC format) yyyy-MM-ddTHH:mm:ss.fffZ

title

string

Name

Appointment name.

description

string

Description

Appointment description.


 

EventProposal

Summary:

Description: A booking, change or cancellation request for a booking from a customer

 

          Properties:

Name

Type

Summary

from_name

string

Customer Name

The name of the customer who made the request.

from_contact

string

Email Address or Phone Number

The phone number or email address of the customer who made the request.

appointment_name

string

Appointment Name

The name of the appointment.

appointment_start

string(date-time)

Appointment Start Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

received

string(date-time)

Request Received Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

type

string

Type of Request

Booking, rebooking or cancellation.

id

string

Request ID Number

The unique identifier of the request in 10to8.


 

GetAppointmentsResponseItem

Summary:

Description: A booked appointment, possibly with a customer

 

          Properties:

Name

Type

Summary

start

string(date-time)

Start Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

end

string(date-time)

End Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

name

string

Name of Appointment

The name or type of the appointment.

customers_name

string

Customer's Name

The full name of the customer.

customers_email

string

Customer's Email Address

The email address of the customer.

customers_number

string

Customer's Phone Number

The phone number of the customer.

id

integer

Appointment ID number

The unique identifier of the appointment in 10to8.


 

GetCustomersResponseItem

Summary:

Description: Details of a customer

 

          Properties:

Name

Type

Summary

name

string

Description

The description of the appointment.

email

string

Customer's Email Address

The contact email address of the customer.

mobile_number

string

Customer's Mobile Number

The contact mobile phone number of the customer.

id

integer

Customer ID Number

The unique identifier of the customer in 10to8.


 

GetOrganisationsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

id

integer

 

 


 

IncomingMessage

Summary:

Description: An incoming message from a customer, either by email or SMS.

 

          Properties:

Name

Type

Summary

from_name

string

Customer Name

The name of the customer who sent the message.

from_contact

string

Phone Number or Email Address

The phone number or email address that the message was sent from.

content

string

Message Content

The Content of the Message.

received

string(date-time)

Received at Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

id

string

Message ID

The unique identifier of the message in 10to8.