Webhooks reference

Subscribe your endpoints to lead.created, escalation.created, assist.fired, and conversion.recorded events — with signed deliveries and a full delivery log.

Events

EventFires when
lead.createdThe mascot captures a lead — contact details plus conversation context.
escalation.createdA conversation is handed off to a human — includes the AI-written brief.
assist.firedThe behavior engine proactively intervenes — trigger, page, and action.
conversion.recordedA conversion is attributed — the event that lets you mirror revenue attribution in your own analytics.

Subscribe a single endpoint to any combination of events.

Setting up

  1. Open Connections in the dashboard and add a webhook.
  2. Enter your endpoint URL (HTTPS required).
  3. Select the events to deliver.
  4. Store the signing secret shown — you'll use it to verify deliveries.
  5. Send a test delivery and confirm your endpoint returns a 2xx.

Verifying deliveries

Each delivery is signed with your webhook's secret so you can verify the payload actually came from Yokaify and wasn't tampered with. Verify the signature before trusting the payload, and reject requests that fail verification.

Delivery behavior

  • Respond fast: return 2xx quickly and process asynchronously — slow endpoints risk timeouts.
  • Expect retries / duplicates: design your handler to be idempotent (use the event's ID as a dedupe key).
  • Delivery log: every attempt, with status and timestamp, is visible on the webhook in the dashboard — debugging never requires guessing whether an event fired.

Common recipes

  • Leads → CRM: point lead.created at your CRM's inbound-webhook endpoint (most support one directly, or via their automation tools).
  • Escalations → on-call chat: escalation.created into a chat webhook gives your team a real-time "human needed" ping with the brief attached.
  • Conversions → warehouse: conversion.recorded into your data pipeline lets your BI mirror Yokaify's attribution.