Skip to main content

Enhanced API Recipe Completion Flow

· One min read

We've enhanced API Recipe completions to provide clear success confirmation and guide developers toward their next learning step.

Completion popup with confetti and next recipe

What's Changed?​

Completion Modal​

A confirmation modal now appears when you complete a recipe, allowing users to navigate back to the API documentation or proceed to the next available recipe, if configured.

Optional Celebration​

Recipe authors can enable confetti animation for milestone recipes or complex walkthroughs to reinforce achievement.

Configuring the Finish Experience​

Recipe authors can customize the completion experience by adding configuration options to the final step of a recipe.

Here is a quick example: 

"Step 5": {
  name: "Complete",
  stepCallback: async () => {
    return workflowCtx.showContent("Well done!");
  },
  showConfettiAnimation: true,
  nextRecipe: {
    name: "Next Recipe",
    link: "page:recipes/next-recipe",
  },
}

If you’re not familiar with API Recipes, refer to the documentation