createApiKeysWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more API keys, which can be secret or publishable. It's used by the Create API Key Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to create API keys within your custom flows.

Source Code

Examples#

Steps#

createApiKeysStep

apiKeysCreated

Workflow Hook

Step conditioned by when

Input#

CreateApiKeysWorkflowInputCreateApiKeysWorkflowInput

The data to create API keys.

api_keysCreateApiKeyDTO[]

The API keys to create.

Output#

ApiKeyDTO[]ApiKeyDTO[]

ApiKeyDTOApiKeyDTO

The API key details.

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.

apiKeysCreated#

This step is a hook that you can inject custom functionality into.

Example

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

Input

Handlers consuming this hook accept the following input.

inputobject

The input data for the hook.

apiKeysApiKeyDTO[]

Was this page helpful?