Webhooks Verification

Rymi can push real-time events to your own backend systems when critical milestones happen—such as a completed transcription or a detected user intent.

The Webhook Payload

Our Outbound Webhook Dispatcher will execute a POST request to your configured URIs.

{
  "event": "transcript.ready",
  "session_id": "call-12345",
  "data": {
    "transcript": "Hello, I want to buy a house."
  }
}

Validating the Signature

To ensure the payload definitively originated from Rymi and wasn't tampered with, every outbound webhook includes an X-Rymi-Signature HTTP header.

This signature is an HMAC-SHA256 hash combining the raw request body and your developer secret.

Example Node.js Validation

const crypto = require('crypto');

function verifySignature(body, signatureHeader, secret) {
    const hash = crypto.createHmac('sha256', secret)
                       .update(JSON.stringify(body))
                       .digest('hex');
                       
    return hash === signatureHeader;
}