Skip to main content

Documentation Index

Fetch the complete documentation index at: https://klipy.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Webhooks

Use webhooks to receive real-time notifications when data changes in Klipy. Common use cases include:
  • Synchronizing leads, deals, and interactions into your CRM.
  • Triggering downstream automations in ops and support tooling.
  • Notifying internal systems when key sales lifecycle milestones occur.
Outbound webhooks are managed in Settings → Webhooks in the Klipy app.

​
What gets sent

Klipy sends outbound webhook events only for outbound-compatible internal events and only when webhooks are enabled for your organization.

​
Set up your endpoint

  1. Open Settings → Webhooks in the Klipy app.
  2. Use the embedded management console to create and configure an endpoint.
  3. Enable organization-level webhooks in the same screen.
  4. Save the endpoint and monitor delivery status from your integration logs.
Only workspace admins can manage webhook settings. A subscription is required to access and use this feature.
  1. Verify each payload signature and enforce idempotency on your side.
  2. Store the event type and event-level identifier from the payload for replay safety.
  3. Return an HTTP 2xx code only after you have persisted successful processing; otherwise, expect retries.

​
Payload structure

Klipy webhooks use the standard event envelope shape and include:
  • type: event type for routing.
  • object: event envelope object name.
  • data: event-specific payload content.

​
Event catalog

See Webhook event types for the per-event index, then open the selected event page for complete payload examples and handling notes.
  1. Read this page for transport and setup expectations.
  2. Open Webhook event types to choose the event you need.
  3. Read the event-specific page for payload contract details before deploying parsing logic.
For each event type, use the dedicated page that matches the event string (lead.captured, deal.closed, etc.) so implementation guidance stays consistent and reviewable.
Last modified on April 26, 2026