Fetch digest config

Fetch the digest/newsletter configuration for a space

Overview

useFetchDigestConfig returns a callable function for fetching a space’s digest configuration. Only space admins can access this endpoint.

Usage Example

import { useFetchDigestConfig } from "@sublay/react-js";

function DigestSettings({ spaceId }: { spaceId: string }) {
  const fetchDigestConfig = useFetchDigestConfig();

  const loadConfig = async () => {
    const config = await fetchDigestConfig({ spaceId });
    console.log(config.digestEnabled, config.digestScheduleHour);
  };
}

Parameters

spaceId · string · required

UUID of the space.

Returns

digestEnabled · boolean

Whether digest delivery is enabled for this space.

digestWebhookUrl · string | null

The URL digest payloads are sent to.

digestWebhookSecret · string | null

Masked as "••••••••" when a secret is configured. Never returned in plain text.

digestScheduleHour · number | null

UTC hour (0–23) when the digest is delivered.

digestTimezone · string | null

IANA timezone for interpreting the schedule hour.

For integration guidance, see Digest & Newsletter.