API de Webhooks

Notificaciones de eventos de reunión en tiempo real

La API de Webhooks permite notificaciones en tiempo real para eventos de reunión, lo que permite a sus aplicaciones recibir actualizaciones sobre el inicio de reuniones, su finalización, eventos de transcripción y más.

  • Reciba notificaciones de reuniones en tiempo real
  • Intégrese con sus herramientas de workflow existentes
  • Cree manejadores de eventos personalizados para eventos de reunión
  • Automatice los procesos posteriores a la reunión

Los webhooks ofrecen una forma eficaz de crear aplicaciones responsivas que reaccionan a los eventos del ciclo de vida de las reuniones sin necesidad de realizar consultas constantes, lo que permite integraciones eficientes con CRMs, plataformas de análisis y otros sistemas empresariales.

Características principales

  • Eventos del ciclo de vida de las reuniones: Reciba notificaciones sobre el inicio, finalización y errores de las reuniones
  • Eventos de transcripción: Obtenga actualizaciones cuando la transcripción esté disponible o se actualice
  • Eventos de calendario: Notificaciones sobre cambios y sincronización del calendario
  • Mecanismo de reintento: Endpoint de API para reintentar entregas de webhook fallidas
  • Endpoints personalizables: Configure diferentes URLs de webhook para distintos tipos de eventos
  • Filtrado de eventos: Controle qué eventos activan las notificaciones

Tipos de eventos de webhook

Los webhooks de Meeting BaaS entregan los siguientes tipos de eventos:

  • meeting.started: Un bot se ha unido exitosamente a una reunión
  • meeting.completed: Una reunión ha finalizado y las grabaciones están disponibles
  • meeting.failed: Un bot no pudo unirse a una reunión
  • transcription.available: La transcripción inicial está disponible
  • transcription.updated: La transcripción ha sido actualizada o refinada
  • calendar.synced: Un calendario ha sido sincronizado
  • event.added: Se ha detectado un nuevo evento de calendario
  • event.updated: Un evento de calendario ha sido actualizado
  • event.deleted: Un evento de calendario ha sido eliminado

Configuración

Configurar el endpoint de webhook

A continuación se muestra un ejemplo de cómo configurar una URL de webhook para eventos de reunión:

Esta configuración JSON muestra cómo configurar un endpoint de webhook en su cuenta de Meeting BaaS.

webhook_config.json
{
  "webhook_url": "https://your-app.com/webhooks/meetingbaas",
  "events": [
    "meeting.started",
    "meeting.completed",
    "meeting.failed",
    "transcription.available"
  ],
  "secret": "your-webhook-secret-key",
  "enabled": true
}

Listar endpoints de webhook

list_webhooks.sh
curl -X GET "https://api.meetingbaas.com/bots/webhooks/bot" \
  -H "x-meeting-baas-api-key: <token>"

Formatos de eventos de webhook

A continuación se muestran ejemplos de payloads de eventos de webhook:

Estos ejemplos JSON muestran el formato de las notificaciones de eventos de reunión iniciada y completada.

Evento de reunión completada

meeting_completed.json
{
  "event": "complete",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000",
    "transcript": [
      {
        "speaker": "John Doe",
        "offset": 1.5,
        "words": [
          {
            "start": 1.5,
            "end": 1.9,
            "word": "Hello"
          },
          {
            "start": 2.0,
            "end": 2.4,
            "word": "everyone"
          }
        ]
      }
    ],
    "speakers": [
      "Jane Smith",
      "John Doe"
    ],
    "mp4": "https://storage.example.com/recordings/video123.mp4?token=abc",
    "event": "complete"
  }
}

Evento de reunión fallida

meeting_failed.json
{
  "event": "failed",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000",
    "error": "meeting_not_found",
    "message": "Could not join meeting: The meeting ID was not found or has expired"
  }
}

Evento de transcripción completada

transcription_complete.json
{
  "event": "transcription_complete",
  "data": {
    "bot_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Ejemplos de implementación

Manejador de webhook en Python

webhook_handler_flask.py
from flask import Flask, request, jsonify
import hmac
import hashlib

app = Flask(__name__)
WEBHOOK_SECRET = "your-webhook-secret-key"

def verify_signature(payload, signature):
    expected_signature = hmac.new(
        WEBHOOK_SECRET.encode(),
        payload,
        hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(signature, expected_signature)

@app.route('/webhooks/meetingbaas', methods=['POST'])
def webhook_handler():
    signature = request.headers.get('X-MeetingBaas-Signature')
    payload = request.get_data()
    
    if not verify_signature(payload, signature):
        return jsonify({"error": "Invalid signature"}), 401
    
    event_data = request.json
    
    if event_data['event'] == 'complete':
        # Handle meeting completion
        bot_id = event_data['data']['bot_id']
        transcript = event_data['data']['transcript']
        recording_url = event_data['data']['mp4']
        
        # Process the meeting data
        process_meeting_completion(bot_id, transcript, recording_url)
        
    elif event_data['event'] == 'failed':
        # Handle meeting failure
        bot_id = event_data['data']['bot_id']
        error = event_data['data']['error']
        message = event_data['data']['message']
        
        # Log the failure
        log_meeting_failure(bot_id, error, message)
    
    return jsonify({"status": "success"}), 200

def process_meeting_completion(bot_id, transcript, recording_url):
    # Your custom logic here
    print(f"Meeting {bot_id} completed")
    print(f"Recording available at: {recording_url}")

if __name__ == '__main__':
    app.run(debug=True, port=5000)
webhook_handler_fastapi.py
from fastapi import FastAPI, Request, HTTPException, Header
import hmac
import hashlib
from typing import Optional

app = FastAPI()
WEBHOOK_SECRET = "your-webhook-secret-key"

def verify_signature(payload: bytes, signature: str) -> bool:
    expected_signature = hmac.new(
        WEBHOOK_SECRET.encode(),
        payload,
        hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(signature, expected_signature)

@app.post("/webhooks/meetingbaas")
async def webhook_handler(
    request: Request,
    x_meetingbaas_signature: Optional[str] = Header(None)
):
    payload = await request.body()
    
    if not x_meetingbaas_signature:
        raise HTTPException(status_code=401, detail="Missing signature")
    
    if not verify_signature(payload, x_meetingbaas_signature):
        raise HTTPException(status_code=401, detail="Invalid signature")
    
    event_data = await request.json()
    
    # Process different event types
    if event_data['event'] == 'complete':
        await handle_meeting_completion(event_data['data'])
    elif event_data['event'] == 'failed':
        await handle_meeting_failure(event_data['data'])
    elif event_data['event'] == 'transcription_complete':
        await handle_transcription_complete(event_data['data'])
    
    return {"status": "success"}

async def handle_meeting_completion(data):
    bot_id = data['bot_id']
    transcript = data['transcript']
    recording_url = data['mp4']
    
    # Your custom logic here
    print(f"Meeting {bot_id} completed")
    print(f"Recording available at: {recording_url}")

async def handle_meeting_failure(data):
    bot_id = data['bot_id']
    error = data['error']
    message = data['message']
    
    # Your custom logic here
    print(f"Meeting {bot_id} failed: {error} - {message}")

async def handle_transcription_complete(data):
    bot_id = data['bot_id']
    
    # Your custom logic here
    print(f"Transcription completed for meeting {bot_id}")

Manejador de webhook en Node.js

webhook_handler_node.js
const express = require('express');
const crypto = require('crypto');
const app = express();

const WEBHOOK_SECRET = 'your-webhook-secret-key';

app.use(express.json());

function verifySignature(payload, signature) {
  const expectedSignature = crypto
    .createHmac('sha256', WEBHOOK_SECRET)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

app.post('/webhooks/meetingbaas', (req, res) => {
  const signature = req.headers['x-meetingbaas-signature'];
  const payload = JSON.stringify(req.body);
  
  if (!verifySignature(payload, signature)) {
    return res.status(401).json({ error: 'Invalid signature' });
  }
  
  const eventData = req.body;
  
  switch (eventData.event) {
    case 'complete':
      handleMeetingCompletion(eventData.data);
      break;
    case 'failed':
      handleMeetingFailure(eventData.data);
      break;
    case 'transcription_complete':
      handleTranscriptionComplete(eventData.data);
      break;
    default:
      console.log(`Unknown event: ${eventData.event}`);
  }
  
  res.json({ status: 'success' });
});

function handleMeetingCompletion(data) {
  const { bot_id, transcript, mp4 } = data;
  console.log(`Meeting ${bot_id} completed`);
  console.log(`Recording available at: ${mp4}`);
  
  // Your custom logic here
  // e.g., save to database, send notifications, etc.
}

function handleMeetingFailure(data) {
  const { bot_id, error, message } = data;
  console.log(`Meeting ${bot_id} failed: ${error} - ${message}`);
  
  // Your custom logic here
  // e.g., retry logic, alert notifications, etc.
}

function handleTranscriptionComplete(data) {
  const { bot_id } = data;
  console.log(`Transcription completed for meeting ${bot_id}`);
  
  // Your custom logic here
  // e.g., process transcript, update database, etc.
}

app.listen(3000, () => {
  console.log('Webhook server running on port 3000');
});

Buenas prácticas

Seguridad

  • Verifique siempre las firmas de los webhooks
  • Utilice endpoints HTTPS
  • Implemente rate limiting
  • Valide los datos de los eventos

Confiabilidad

  • Devuelva códigos de estado 200 rápidamente
  • Implemente idempotencia
  • Maneje eventos duplicados
  • Configure monitoreo y alertas

Manejo de errores

  • Registre todos los eventos de webhook en los logs
  • Implemente lógica de reintento para los fallos
  • Configure colas de mensajes fallidos
  • Monitoree el estado de entrega de los webhooks
Meeting BaaS API Preview Features

Comenzar

¿Listo para integrar notificaciones de reuniones en tiempo real? Consulte nuestros recursos completos: