Clarityflow API
  • Clarityflow Developer API
  • Authentication
  • Webhooks
    • Webhook Event for Conversation Created
    • Webhook Event for Message Created
    • Webhook Event for Message Viewed
    • Webhook Event for Appointment Scheduled
    • Webhook Event for Product Purchased
    • Webhook Event for Form Submission
  • API Reference
    • Conversations
    • Messages
Powered by GitBook
On this page
  • Registering Webhooks
  • Consuming Webhooks
  • Webhook Events

Webhooks

Listen for events happening in Clarityflow.

PreviousAuthenticationNextWebhook Event for Conversation Created

Last updated 1 day ago

Webhooks enable your app or service to listen for events happening in Clarityflow and get notified via HTTP POST requests.

Tip: is a handy utility for testing webhooks and inspecting their payloads.

Registering Webhooks

Go to Settings > Integrations > Manage Webhooks.

Input the Webhook URL.

Select at least 1 Clarityflow event to trigger sending to this webhook URL.

Consuming Webhooks

When an event occurs that triggers a webhook, we will send an HTTP POST to the URL you specified, with a JSON-encoded body.

Webhook request bodies include:

{
  "type": "conversation_created",
  "id": "862f22c9-b692-4b3f-9d7e-dcf64172719e",
  "occurred_at": "2022-04-01T10:06:53.992-04:00",
  "payload": {
    ...
  }
}

Webhook Events

As of this writing (December 2024), webhooks can be sent when the following events occur in Clarityflow. Click each to get more information about the data sent with each request:

  • A task was completed

You can also add filters on some of the events, for example, specific products purchased or specific forms submitted.

New Conversation
New Message
A Message was viewed
An appointment was scheduled
A purchase was made
A form was submitted
webhook.site