Flow

Contains functions for verifying Shopify Flow extensions. See the [Flow documentation](https://shopify.dev/docs/apps/flow/actions/endpoints) for more information.

import {type ActionFunctionArgs} from '@remix-run/node';

import {authenticate} from '../shopify.server';

export const action = async ({request}: ActionFunctionArgs) => {
  const {admin, payload} = await authenticate.flow(request);

  const customerId = payload.properties.customer_id;

  const response = await admin.graphql(
    `#graphql
    mutation setMetafield($customerId: ID!, $time: String!) {
      metafieldsSet(metafields: {
        ownerId: $customerId
        namespace: "my-app",
        key: "last_flow_update",
        value: $time,
        type: "string",
      }) {
        metafields {
          key
          value
        }
      }
    }
    `,
    {
      variables: {
        customerId,
        time: new Date().toISOString(),
      },
    },
  );
  const body = await response.json();

  console.log('Updated value', body.data!.metafieldsSet!.metafields![0].value);

  return new Response();
};

authenticate.flow

Verifies requests coming from Shopify Flow extensions.

AuthenticateFlow

Returns: Promise<FlowContext<ConfigArg, Resources>>

Params:

request: Request

export type AuthenticateFlow< ConfigArg extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources, > = (request: Request) => Promise<FlowContext<ConfigArg, Resources>>;

FlowContext

admin

An admin context for the Flow request. Returned only if there is a session for the shop.

payload

The payload from the Flow request.

session

A session with an offline token for the shop. Returned only if there is a session for the shop.

Related

• Admin API context
• Flow action endpoints

Examples

Contains functions for verifying Shopify Flow extensions. See the [Flow documentation](https://shopify.dev/docs/apps/flow/actions/endpoints) for more information.

admin

import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";

export async function action({ request }: ActionFunctionArgs) {
  const { admin } = await authenticate.flow(request);

  const response = await admin?.graphql(
    `#graphql
    mutation populateProduct($input: ProductInput!) {
      productCreate(input: $input) {
        product {
          id
        }
      }
    }`,
    { variables: { input: { title: "Product Name" } } }
  );

  const productData = await response.json();
  return json({ data: productData.data });
}

payload

import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";

export const action = async ({ request }: ActionFunctionArgs) => {
  const { payload } = await authenticate.flow(request);
  return new Response();
};

session

import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";

export const action = async ({ request }: ActionFunctionArgs) => {
  const { session, admin } = await authenticate.flow(request);

  console.log(session.id)

  return new Response();
};