Skip to main content

Overview

useUpdateDigestConfig returns a callable function for updating a space’s digest configuration. Only space admins can update this. All fields are optional — only provided fields are updated.

Usage Example

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

function DigestSettings({ spaceId }: { spaceId: string }) {
  const updateDigestConfig = useUpdateDigestConfig();

  const handleSave = async () => {
    await updateDigestConfig({
      spaceId,
      update: {
        digestEnabled: true,
        digestWebhookUrl: "https://your-server.com/hooks/digest",
        digestScheduleHour: 8,
        digestTimezone: "Europe/London",
      },
    });
  };
}

Parameters

spaceId
string
required
UUID of the space.
update
object
required
Object containing the digest config fields to update. All fields are optional — only provided fields are changed.

Returns

The updated digest configuration object.
digestEnabled
boolean
Whether digest delivery is enabled.
digestWebhookUrl
string | null
URL digests are POSTed to, or null if not set.
digestWebhookSecret
string | null
Masked secret ("••••••••") when set, or null if not configured.
digestScheduleHour
number | null
UTC hour (0–23) for digest delivery, or null if not set.
digestTimezone
string | null
IANA timezone string, or null if not set.
For integration guidance, see Digest & Newsletter.