createCampaignsWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the createCampaignsWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow creates one or more campaigns. It's used by the Create Campaign Admin API Route.

This workflow has a hook that allows you to perform custom actions on the created campaigns. For example, you can pass under additional_data custom data that allows you to create custom data models linked to the campaigns.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating campaigns.

Examples#

Steps#

Input#

Output#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

campaignsCreated#

This hook is executed after the campaigns are created. You can consume this hook to perform custom actions on the created campaigns.

Example

Code
1import { createCampaignsWorkflow } from "@medusajs/medusa/core-flows"2
3createCampaignsWorkflow.hooks.campaignsCreated(4  (async ({ campaigns, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.