Digest Action for Framework Based Workflows

You can use the Digest Engine to collect multiple events to a single message. Learn more about the Digest Engine.

​

Defining a digest step

const digestResult = await step.digest("digest", async () => {
  return {
    unit: "days", // 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months'
    amount: 3, // the number of units to digest events for
  };
});

​

Writing digest content

In many cases, you will need to access all the digested events payload in order to show the user all or parts of the events included in this digest.

For example: “John and 5 others liked your photo.”

The digest function returns an array of triggers that have been digested. You can use this array to perform any necessary actions on the digested triggers. Like Sending and email, or updating a database.

const { events } = await step.digest("digest-3-days", async () => {
  return {
    unit: "days", // 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months'
    amount: 3, // the number of units to digest events for
  };
});

await step.email("send-email", async () => {
  const eventCount = events.length;

  return {
    subject: "Digest Email",
    body: `You have ${eventCount} new events`,
  };
});

The digest step returns an object with events array. Each event in the array has the following properties:

• id - The job id of the digested event
• time - The time when the event was triggered
• payload - The original payload passed to the event