---
title: "Changes to Generate a step preview"
method: POST
path: "/v2/workflows/{workflowId}/step/{stepId}/preview"
---

# Changes to Generate a step preview

`POST /v2/workflows/{workflowId}/step/{stepId}/preview`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 6 of 20 revisions.

- **2026-09-28** `f056922796ad`: 4 warning, 4 info
- **2026-08-30** `24e82408dec7`: 2 breaking, 2 warning, 4 info
- **2026-08-16** `c2b2fa0d5d48`: 2 breaking, 2 warning, 4 info
- **2026-08-04** `ca78ba235703`: 1 breaking, 1 info
- **2026-07-31** `8092e41edd57`: 2 warning, 2 info
- **2026-07-21** `c69777f60184`: 1 breaking, 6 warning, 6 info

## Changes

- **2026-09-28** `f056922796ad`: 4 warning, 4 info
  - added the new `google-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `google-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `photon-imessage` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `photon-imessage` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `google-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `google-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `photon-imessage` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `photon-imessage` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
- **2026-08-30** `24e82408dec7`: 2 breaking, 2 warning, 4 info
  - removed the enum value `novu-agent-chat` of the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - removed the enum value `novu-agent-chat` of the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `novu-web-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-web-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-web-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `novu-web-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - removed the `novu-agent-chat` enum value from the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - removed the `novu-agent-chat` enum value from the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
- **2026-08-16** `c2b2fa0d5d48`: 2 breaking, 2 warning, 4 info
  - removed the enum value `novu-web-chat` of the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - removed the enum value `novu-web-chat` of the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `novu-agent-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-agent-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-agent-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `novu-agent-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - removed the `novu-web-chat` enum value from the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - removed the `novu-web-chat` enum value from the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
- **2026-08-04** `ca78ba235703`: 1 breaking, 1 info
  - the response property `result/oneOf[subschema #7]/preview/body` became optional for the status `201`
  - added the optional property `result/oneOf[subschema #7]/preview/card` to the response with the `201` status
- **2026-07-31** `8092e41edd57`: 2 warning, 2 info
  - added the new `novu-web-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-web-chat` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `novu-web-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `novu-web-chat` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
- **2026-07-21** `c69777f60184`: 1 breaking, 6 warning, 6 info
  - added `subschema #8` to the `result` response property `oneOf` list for the response status `201`
  - added the new `line` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `line` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `sendblue` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `sendblue` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `webex-messaging` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `webex-messaging` enum value to the `previewPayloadExample/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId` response property for the response status `201`
  - added the new `line` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `line` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `sendblue` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `sendblue` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `webex-messaging` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/actor/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`
  - added the new `webex-messaging` enum value to the request property `previewPayload/allOf[#/components/schemas/PreviewPayloadDto]/subscriber/allOf[#/components/schemas/SubscriberResponseDtoOptional]/channels/items/providerId`

---

[Operation](https://skmtc.dev/novu/apis/novu-api/docs/v2/workflows/:workflowId/step/:stepId/preview/post.md) - [API](https://skmtc.dev/novu/apis/novu-api.md) - [Page](https://skmtc.dev/novu/apis/novu-api/changes/v2/workflows/:workflowId/step/:stepId/preview/post)