Skip to main content
Spaces can be configured to send a digest — a summary of recent content — to a webhook endpoint on a scheduled basis. This enables newsletter-style integrations where space activity is delivered to an external system (email platform, Slack, CMS, etc.).

How It Works

The digest system is configured per space by admins. When enabled, Replyke periodically sends a webhook payload to the configured URL containing recent space activity. The exact delivery format and payload structure are determined by the webhook handler on your server.

Fetching Digest Config

Only space admins can fetch the digest configuration:
import { useFetchDigestConfig } from "@replyke/react-js";

const fetchDigestConfig = useFetchDigestConfig();
const config = await fetchDigestConfig({ spaceId });

// config: {
//   digestEnabled: boolean,
//   digestWebhookUrl: string | null,
//   digestWebhookSecret: string | null,  // Masked as "••••••••" when set
//   digestScheduleHour: number | null,   // 0-23 (UTC hour of delivery)
//   digestTimezone: string | null,
// }
The digestWebhookSecret is masked in the response when a secret is set. It is never returned in plain text.

Updating Digest Config

import { useUpdateDigestConfig } from "@replyke/react-js";

const updateDigestConfig = useUpdateDigestConfig();

await updateDigestConfig({
  spaceId,
  digestEnabled: true,
  digestWebhookUrl: "https://your-server.com/hooks/digest",
  digestWebhookSecret: "your-secret-token",
  digestScheduleHour: 9,    // 9 AM
  digestTimezone: "America/New_York",
});

Configuration Fields

FieldTypeDescription
digestEnabledbooleanEnable or disable digest delivery.
digestWebhookUrlstring | nullURL to POST the digest payload to.
digestWebhookSecretstring | nullSecret for verifying webhook authenticity. Pass null to clear.
digestScheduleHournumber | nullUTC hour (0–23) when the digest is sent.
digestTimezonestring | nullIANA timezone string for schedule interpretation (e.g., "America/New_York").

Hook Reference

HookDescription
useFetchDigestConfigFetch the digest configuration for a space
useUpdateDigestConfigUpdate the digest configuration