Skip to main content

Adding Custom Text Support to the API Recipe Finish Modal

· 2 min read

We've added the ability for recipe authors to customize the completion message and suggested next recipe label shown in the finish modal, giving you full control over how users are greeted at the end of a recipe.

Custom text in the API Recipe finish modal

What's Changed?​

Building on the Enhanced API Recipe Completion Flow, the finish modal now supports two additional text customizations:

Custom Completion Message​

The modal description — previously fixed to "You've successfully completed <recipe name> recipe." — can now be replaced with any message that fits your recipe's tone or context.

Custom Next Recipe Label​

The label above the suggested next recipe card, previously hardcoded as "Suggested Next Recipe", can now be set to any text. This is useful when the relationship between recipes isn't strictly sequential — for example, "Related Recipe" or "Continue Your Journey".

Configuring the Custom Text​

Both options are set on the final step of a recipe alongside the existing nextRecipe and showConfettiAnimation fields.

"Step 5": {
  name: "Complete",
  stepCallback: async () => {
    return workflowCtx.showContent("Well done!");
  },
  showConfettiAnimation: true,
  completionMessage: "You're all set! Your integration is ready to go.",
  nextRecipe: {
    name: "OAuth 2.0 Authentication",
    link: "page:recipes/oauth2-auth",
    label: "Continue Your Journey",
  },
}

Both completionMessage and nextRecipe.label are optional — when omitted, the modal falls back to the default text. For full details, see the Advanced Features reference. If you're new to API Recipes, start with the overview.