Webhooks

Use webhooks when a server needs notifications independent of an active client connection.

For a live progress display or a one-off render, use getRenderProgress or getFileProcessingProgress. These functions consume event streams.

No SDK function registers a webhook. Configure one on an API key, through the dashboard (Settings → API Keys, or editframe.com/resource/api_keys). Set a Webhook URL (this must use HTTPS). Select which Webhook Events (topics) to receive. When you create or update the key, the dashboard generates a Webhook Secret, used to sign deliveries. Copy this secret and store it alongside the API key.

Handling a Webhook

Verify the signature and validate the payload before acceptance. Persist the event before you return success.

The example accepts an application-defined acceptEvent function. It must commit to a durable inbox or queue before its promise resolves.

import express from "express";
import crypto from "node:crypto";