Activity Message Types Reference

This document lists all message types returned by the GET /v3/communication/activity_messages endpoint, organized by activity type (messageable type).


Direction Values

DirectionDescription
pivot_to_clientMessage sent from the business to the client
client_to_pivotMessage sent from the client to the business
to_pivotSystem notification delivered to the business side
to_clientSystem notification delivered to the client side

Meaning

Message TypeDirectionMeaning
schedule_invitationpivot_to_clientStaff scheduled a new appointment with the client.
scheduleclient_to_pivotClient online scheduled a new appointment, and it was auto-approved.
requestclient_to_pivotClient scheduled a meeting online and it is pending business approval.
request_notificationpivot_to_clientBusiness sent an automatic reply acknowledging the client's meeting request is being handled.
schedule_updatepivot_to_clientStaff updated the meeting details.
updatedpivot_to_clientStaff updated the meeting details.
updatedto_pivotBusiness is notified that meeting details were updated.
cancelledpivot_to_clientStaff cancelled a meeting with the client.
cancelledclient_to_pivotClient cancelled a meeting online.
acceptedpivot_to_clientStaff approved a pending meeting request from the client.
acceptedclient_to_pivotClient accepted a tentative meeting scheduled by the staff.
rejectedpivot_to_clientStaff declined a meeting request the client made online.
rejectedclient_to_pivotClient declined a meeting.
completedto_pivotThe appointment was marked as completed.
rescheduleclient_to_pivotClient rescheduled an appointment online.
rescheduleto_pivotBusiness is notified that a meeting was rescheduled.
schedule_client_updateclient_to_pivotClient changed the meeting time online.
schedule_client_update_notificationpivot_to_clientStaff is notified of a change the client made to the appointment online.
propose_timepivot_to_clientStaff is proposing a new time for the appointment to the client.
please_reschedulepivot_to_clientBusiness is asking the client to reschedule the appointment online.
invitepivot_to_clientBusiness is inviting the client to schedule online.
rsvp_confirmationclient_to_pivotClient confirmed attendance to a future meeting.
thank_you_notepivot_to_clientStaff sent a follow-up thank you message after the meeting.
missed_notepivot_to_clientClient did not attend the meeting, so staff sends a follow-up message.
expiredclient_to_pivotClient's meeting request expired before the business responded — staff is notified.
expiredpivot_to_clientClient's meeting request expired before the business responded — client is notified.
request_cancelledclient_to_pivotClient cancelled a meeting request they made online.
request_cancelledpivot_to_clientBusiness cancelled a meeting invitation that was not yet approved by the client.
tentativeto_clientClient is notified of a tentatively scheduled meeting pending their confirmation.
meeting_reminderto_pivotSystem sends an upcoming appointment reminder to the business.
meeting_reminderto_clientSystem sends an upcoming appointment reminder to the client.
meeting_request_reminderto_clientClient receives a reminder about their pending meeting request.
meeting_request_reminderto_pivotBusiness receives a reminder about a pending meeting request awaiting approval.
schedule_notificationto_clientClient receives a confirmation notification that a meeting was scheduled.
schedule_update_notificationto_pivotBusiness receives a notification that meeting details were updated.
cancelled_notificationto_pivotBusiness receives a notification that a meeting was cancelled.
cancelled_notificationto_clientClient receives a notification that a meeting was cancelled.
accepted_notificationto_pivotBusiness receives a notification that a meeting request was accepted.
accepted_notificationto_clientClient receives a notification that their meeting was accepted.
add_additional_staffto_pivotAn additional staff member was assigned to the meeting.
remove_additional_staffto_pivotAn additional staff member was removed from the meeting.
booking_reassignedto_pivotThe meeting was reassigned to a different staff member.
dispatch_scheduleto_pivotA meeting was dispatched and assigned to a staff member.
dispatch_cancelto_pivotA dispatched meeting assignment was cancelled.

Appointment Series

Message TypeDirectionMeaning
scheduledpivot_to_clientBusiness scheduled a recurring appointment series with the client.
scheduled_notificationto_pivotBusiness is notified that a recurring appointment series was scheduled.
schedule_updatepivot_to_clientA recurring appointment series time was updated.
schedule_update_notificationto_pivotBusiness is notified that a recurring appointment series was updated.
updatedpivot_to_clientBusiness updated the details of a recurring appointment series.
updatedto_pivotBusiness is notified that a recurring appointment series was updated.
cancelledpivot_to_clientBusiness cancelled a series of appointments.
cancelled_notificationto_pivotBusiness is notified that a recurring appointment series was cancelled.
add_additional_staffto_pivotAn additional staff member was assigned to the appointment series.
remove_additional_staffto_pivotAn additional staff member was removed from the appointment series.
booking_reassignedto_pivotThe appointment series was reassigned to a different staff member.
dispatch_scheduleto_pivotAn appointment series was dispatched and assigned to a staff member.
dispatch_cancelto_pivotA dispatched appointment series assignment was cancelled.

Linked Booking

Message TypeDirectionMeaning
schedule_invitationpivot_to_clientBusiness scheduled several appointments with the client.
cancelledpivot_to_clientBusiness cancelled multiple linked meetings with the client.

Invoice

Message TypeDirectionMeaning
message_requestpivot_to_clientStaff sent an invoice to the client.
reminderto_pivotBusiness receives a reminder to follow up on an open invoice.
client_reminderto_clientSystem sends the client a reminder about an unpaid invoice.
client_reminderpivot_to_clientBusiness sends a reminder to the client to pay for an invoice.

Estimate

Message TypeDirectionMeaning
requestpivot_to_clientBusiness sent a new price estimate to the client.
approvedclient_to_pivotClient approved the price estimate.
approvedpivot_to_clientBusiness sends a confirmed estimate to the client.
rejectedclient_to_pivotClient rejected the price estimate.
rejectedpivot_to_clientBusiness cancelled a price estimate.
expiringpivot_to_clientA price estimate is about to expire.
expiredto_pivotBusiness is notified that a price estimate has expired.

Payment

Message TypeDirectionMeaning
payment_receivedclient_to_pivotClient paid online.
payment_receivedto_pivotBusiness is notified that a payment was received.
payment_received_notificationpivot_to_clientClient received confirmation of their payment.
payment_received_notificationto_clientClient receives a system notification confirming their payment.
receipt_sentto_clientSystem notification that a receipt was sent to the client.
receipt_sentpivot_to_clientA receipt was sent to the client.
receipt_sentto_pivotBusiness is notified that a receipt was sent.
bank_paymentto_clientClient receives confirmation of a bank transfer payment.
payment_refunded_notificationto_clientSystem notification that a payment refund was processed.
payment_refunded_notificationpivot_to_clientBusiness refunded a payment to the client.
cancelledto_pivotBusiness is notified that a payment was cancelled.
payment_pendingto_pivotBusiness is notified of a pending payment.
payment_failedto_pivotBusiness is notified that a payment attempt failed.
payment_offline_refunded_notificationto_pivotBusiness is notified of an offline payment refund.
archivedto_pivotBusiness is notified that a payment was archived.
undo_archivedto_pivotBusiness is notified that a payment was unarchived.
pending_payment_failedto_pivotBusiness is notified that a pending payment failed.
scheduled_payment_failedto_pivotBusiness is notified that a scheduled payment failed.

Payment Status

Message TypeDirectionMeaning
send_linkpivot_to_clientBusiness sent a payment request link to the client.

Payment Card

Message TypeDirectionMeaning
payment_method_addedto_pivotBusiness is notified that a client added a payment method on file.

Card Request

Message TypeDirectionMeaning
card_requestedto_clientClient receives a request to provide their payment card details.

Scheduled Payments Rule

Message TypeDirectionMeaning
scheduled_payments_rule_createdpivot_to_clientBusiness created a subscription or scheduled payment plan for the client.

Event Attendance

Message TypeDirectionMeaning
event_attendance_invitepivot_to_clientStaff invited the client to register for an event or class.
event_attendance_register_notificationpivot_to_clientStaff registered a client for an event or class.
event_attendance_client_registerclient_to_pivotClient registered for an event or class online.
event_attendance_business_cancelpivot_to_clientStaff cancelled a client's registration to an event or class.
event_attendance_client_cancelclient_to_pivotClient cancelled their registration to an event or class online.
event_attendance_client_cancel_notificationpivot_to_clientStaff is notified that a client cancelled their event or class registration.
event_attendance_rescheduledpivot_to_clientBusiness changed the time of an event or class.
event_attendance_event_cancelledpivot_to_clientBusiness cancelled an event or class.
rsvp_confirmationclient_to_pivotClient confirmed arrival to an event or class.
event_attendance_reminderto_clientClient receives a reminder about an upcoming event or class.
booking_reassignedto_pivotAn event registration was reassigned to a different staff member.

Event Series Attendance

Message TypeDirectionMeaning
event_series_attendance_invitepivot_to_clientBusiness invited the client to join a series of events or classes.
event_series_attendance_updatedpivot_to_clientBusiness updated the details of a series of events or classes.
event_series_attendance_cancelledpivot_to_clientBusiness cancelled a client's attendance to a series of events or classes.
booking_reassignedto_pivotAn event series registration was reassigned to a different staff member.

Waitlist

Message TypeDirectionMeaning
register_to_event_waitlistclient_to_pivotClient requested to join a waitlist for an upcoming event or class.
register_to_event_waitlistto_clientClient receives confirmation of their waitlist registration.
register_to_event_waitlistpivot_to_clientBusiness registered a client to a waitlist for an event or class.
register_to_event_waitlistto_pivotBusiness is notified that a client registered to a waitlist.
textpivot_to_clientBusiness offers a waitlisted client a spot in the event or class.
cancel_waitlist_registrationto_pivotBusiness is notified that a client cancelled their waitlist registration.

Client Booking Package

Message TypeDirectionMeaning
package_addedpivot_to_clientBusiness added a package of services to the client's profile.
package_purchasedclient_to_pivotClient purchased a package of services online.
resend_linkpivot_to_clientBusiness sent a link to purchase a package to the client.

Product Order

Message TypeDirectionMeaning
product_addedpivot_to_clientBusiness added a new product to the client's CRM card.

Announcement

Message TypeDirectionMeaning
custompivot_to_clientBusiness sent an invitation to take online actions through the client portal.
close_open_paymentspivot_to_clientBusiness sent a link to the client portal for payment.
livesitepivot_to_clientBusiness is inviting the client to take online actions on their website.
recover_documentpivot_to_clientBusiness invites the client to re-share a document online.

Document

Message TypeDirectionMeaning
documentclient_to_pivotClient shared a document with the business.

Review

Message TypeDirectionMeaning
submit_reviewclient_to_pivotClient submitted an online review for the business.

Voice Call

Message TypeDirectionMeaning
callclient_to_pivotClient called the business over the phone (regardless of the call outcome).

General (No Specific Activity Type)

These message types have no associated messageable type and represent general communication or system events.

Message TypeDirectionMeaning
textclient_to_pivotClient replied to the staff.
textpivot_to_clientStaff replied to the client.
textto_pivotA text message was received via an external messaging channel (e.g., Facebook, WhatsApp).
apiclient_to_pivotClient contacted the business (via API-initiated communication).
general_questionclient_to_pivotClient submitted a contact form.
business_textclient_to_pivotClient replied via SMS to the business.
documentclient_to_pivotClient shared a file with the business.
documentpivot_to_clientBusiness shared a file with the client.
close_open_paymentspivot_to_clientBusiness sent a request to the client to pay all open payments.
document_client_pending_approvalpivot_to_clientBusiness sent a document for client approval.
systemclient_to_pivotInternal CRM activity update.
activityclient_to_pivotInternal CRM activity recorded for the client.
matter_assignedto_pivotA client conversation was assigned to a staff member.
sent_notificationto_clientSystem notification confirming that a message was sent.
document_client_notificationto_clientClient receives a notification that a document was shared with them.
engagement_reminderto_pivotBusiness receives a reminder to follow up on a client conversation.