Webhooks | Communication Outbound

Overview

The Communication Outbound Webhook is designed to trigger whenever a client purchases a package or membership across your corporate setup. It allows your system to receive real-time updates on outbound communications, including SMS and email messages.

Important note: Webhooks are currently only available for brand-level data (all locations).

Trigger Event:

This webhook activates when a package or membership is purchased by a client.

Event Type:

outboundMessage

Payload Details:

clientID: Unique identifier for the client.
siteID: Identifier for the site where the purchase occurred.
email: Client’s email address.
messageId: Unique ID for the message sent.
communicationType: Indicates whether the message is an SMS or email.
message: The content of the communication (plain text for SMS, HTML for emails).
phone (for SMS): Phone number used for SMS messages.
emailTo, emailFrom, subject (for Email): Details specific to email communication.

Usage Example:

Automatically send a confirmation SMS or email to a client after they purchase a membership.
Update your CRM system with records of client communications.