These are the request bodies for each event that can trigger webhooks:
Conversation created
This event occurs when a new Clarityflow (formerly known as ZipMessage) conversation is created. Conversations can be created in any of the following ways:
You or a teammate clicks "Create Conversation" in your Clarityflow account interface.
A guest submits a message via any of your intake page(s). This generates a new Conversation.
A Conversation can be created via Zapier.
A Conversation can be created via the API.
A Conversation can be creating by using our browser extensions.
Messages reside in Conversations. A Message is created when someone has posted a message in a conversation. A Message can have video, audio, and/or text content. A message may be sent by an identified person or sent anonymously.
Messages are created in any of these ways:
A user views a conversation then creates and posts a message in it.
This event fires when a message's media (video or audio) player has been played back by someone. The person playing a message can be an identified logged-in user or an anonymous viewer.
This webhook follows the same logic as notifications for when a message is played. Some notes:
The webhook fires once per user playing a message.
The webhook fires once per user's session.
The webhook only fires if the message being played has an author (the message wasn't posted anonymously).
Examples:
If a logged-in user plays a message for the first time, this will fire the webhook. But if that same user plays the same message a 2nd time, it will not send an additional webhook for the 2nd play.
A non-logged-in visitor plays a message once, which fires the webhook. During the same browser session, this user presses play on the same message a 2nd time. This 2nd play does not fire an additional webhook.