Contains functions for verifying Shopify webhooks. > Note: The format of the `admin` object returned by this function changes with the `v3_webhookAdminContext` future flag. Learn more about [gradual feature adoption](/docs/api/shopify-app-remix/guide-future-flags).
import {type ActionFunctionArgs} from '@remix-run/node';
import {authenticate} from '../shopify.server';
export const action = async ({request}: ActionFunctionArgs) => {
const {topic, admin, payload} = await authenticate.webhook(request);
switch (topic) {
case 'PRODUCTS_UPDATE':
await admin.graphql(
`#graphql
mutation setMetafield($productId: ID!, $time: String!) {
metafieldsSet(metafields: {
ownerId: $productId
namespace: "my-app",
key: "webhook_received_at",
value: $time,
type: "string",
}) {
metafields {
key
value
}
}
}
`,
{
variables: {
productId: payload.admin_graphql_api_id,
time: new Date().toISOString(),
},
},
);
return new Response();
}
throw new Response();
};
Verifies requests coming from Shopify webhooks.
request: Request
export type AuthenticateWebhook< Future extends FutureFlagOptions, Resources extends ShopifyRestResources, Topics = string | number | symbol, > = (request: Request) => Promise<WebhookContext<Future, Resources, Topics>>;
WebhookContextWithoutSession<Topics> | WebhookContextWithSession<Future, Resources, Topics>
The API version used for the webhook.
The shop where the webhook was triggered.
The topic of the webhook.
A unique ID for the webhook. Useful to keep track of which events your app has already processed.
The payload from the webhook request.
The sub-topic of the webhook. This is only available for certain webhooks.
A session with an offline token for the shop. Returned only if there is a session for the shop.
An admin context for the webhook. Returned only if there is a session for the shop.
The API version used for the webhook.
The shop where the webhook was triggered.
The topic of the webhook.
A unique ID for the webhook. Useful to keep track of which events your app has already processed.
The payload from the webhook request.
The sub-topic of the webhook. This is only available for certain webhooks.
Stores App information from logged in merchants so they can make authenticated requests to the Admin API.
The unique identifier for the session.
The Shopify shop domain, such as `example.myshopify.com`.
The state of the session. Used for the OAuth authentication code flow.
Whether the access token in the session is online or offline.
The desired scopes for the access token, at the time the session was created.
The date the access token expires.
The access token for the session.
Information on the user for the session. Only present for online sessions.
Whether the session is active. Active sessions have an access token that is not expired, and has the given scopes.
Whether the access token has the given scopes.
Whether the access token is expired.
Converts an object with data into a Session.
Checks whether the given session is equal to this session.
Converts the session into an array of key-value pairs.
How long the access token is valid for, in seconds.
The effective set of scopes for the session.
The user associated with the access token.
The user's ID.
The user's first name.
The user's last name.
The user's email address.
Whether the user has verified their email address.
Whether the user is the account owner.
The user's locale.
Whether the user is a collaborator.
A class that represents a set of access token scopes.
Checks whether the current set of scopes includes the given one.
Checks whether the current set of scopes equals the given one.
Returns a comma-separated string with the current set of scopes.
Returns an array with the current set of scopes.
The unique identifier for the session.
The Shopify shop domain.
The state of the session. Used for the OAuth authentication code flow.
Whether the access token in the session is online or offline.
The scopes for the access token.
The date the access token expires.
The access token for the session.
Information on the user for the session. Only present for online sessions.
Omit<OnlineAccessInfo, 'associated_user'> & { associated_user: Partial<OnlineAccessUser>; }
FeatureEnabled<Future, 'v3_webhookAdminContext'> extends true ? AdminApiContext<Resources> : LegacyWebhookAdminApiContext<Resources>
Config['isEmbeddedApp'] extends false ? NonEmbeddedAdminContext<Config, Resources> : EmbeddedAdminContext<Config, Resources>
The session for the user who made the request. This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice. Use this to get shop or user-specific data.
Methods for interacting with the GraphQL / REST Admin APIs for the store that made the request.
Billing methods for this store, based on the plans defined in the `billing` config option.
A function that ensures the CORS headers are set correctly for the response.
Methods for interacting with the Shopify Admin REST API There are methods for interacting with individual REST resources. You can also make `GET`, `POST`, `PUT` and `DELETE` requests should the REST resources not meet your needs.
Methods for interacting with the Shopify Admin GraphQL API
RemixRestClient & {resources: Resources}
Performs a GET request on the given path.
Performs a POST request on the given path.
Performs a PUT request on the given path.
Performs a DELETE request on the given path.
The path to the resource, relative to the API version root.
The type of data expected in the response.
The request body.
Query parameters to be sent with the request.
Additional headers to be sent with the request.
The maximum number of times the request can be made if it fails with a throttling or server error.
Headers to be sent with the request.
Record<string, string | number | string[]>
GetRequestParams & { data: Record<string, any> | string; }
query: Operation extends keyof Operations
options: GraphQLQueryOptions<Operation, Operations>
export type GraphQLClient<Operations extends AllOperations> = < Operation extends keyof Operations, >( query: Operation, options?: GraphQLQueryOptions<Operation, Operations>, ) => Promise<GraphQLResponse<Operation, Operations>>;
The variables to pass to the operation.
The version of the API to use for the request.
Additional headers to include in the request.
The total number of times to try the request if it fails.
Checks if the shop has an active payment for any plan defined in the `billing` config option.
Checks if the shop has an active payment for any plan defined in the `billing` config option.
Requests payment for the plan.
Cancels an ongoing subscription, given its ID.
The plans to check for. Must be one of the values defined in the `billing` config option.
How to handle the request if the shop doesn't have an active payment for any plan.
Whether to consider test purchases.
Whether the user has an active payment method.
The one-time purchases the shop has.
The active subscriptions the shop has.
The ID of the one-time purchase.
The name of the purchased plan.
Whether this is a test purchase.
The status of the one-time purchase.
The ID of the app subscription.
The name of the purchased plan.
Whether this is a test subscription.
BillingConfigSubscriptionPlanDiscountAmount | BillingConfigSubscriptionPlanDiscountPercentage
The amount to discount. Cannot be set if `percentage` is set.
The percentage to discount. Cannot be set if `amount` is set.
The amount to discount. Cannot be set if `percentage` is set.
The percentage to discount. Cannot be set if `amount` is set.
The plans to check for. Must be one of the values defined in the `billing` config option.
Whether to consider test purchases.
The plan to request. Must be one of the values defined in the `billing` config option.
Whether to use the test mode. This prevents the credit card from being charged. Test shops and demo shops cannot be charged.
The URL to return to after the merchant approves the payment.
The ID of the subscription to cancel.
Whether to prorate the cancellation.
export interface EnsureCORSFunction { (response: Response): Response; }
The decoded and validated session token for the request. Returned only if `isEmbeddedApp` is `true`.
A function that redirects the user to a new page, ensuring that the appropriate parameters are set for embedded apps. Returned only if `isEmbeddedApp` is `true`.
The session for the user who made the request. This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice. Use this to get shop or user-specific data.
Methods for interacting with the GraphQL / REST Admin APIs for the store that made the request.
Billing methods for this store, based on the plans defined in the `billing` config option.
A function that ensures the CORS headers are set correctly for the response.
The shop's admin domain.
The shop's domain.
The client ID of the receiving app.
The User that the session token is intended for.
When the session token expires.
When the session token activates.
When the session token was issued.
A secure random UUID.
A unique session ID per user and app.
url: string
init: RedirectInit
export type RedirectFunction = ( url: string, init?: RedirectInit, ) => TypedResponse<never>;
number | (ResponseInit & {target?: RedirectTarget})
'_self' | '_parent' | '_top'
A REST client.
A GraphQL client.
Performs a GET request on the given path.
Performs a POST request on the given path.
Performs a PUT request on the given path.
Performs a DELETE request on the given path.
Record<string, string | string[]>
Contains functions for verifying Shopify webhooks. > Note: The format of the `admin` object returned by this function changes with the `v3_webhookAdminContext` future flag. Learn more about [gradual feature adoption](/docs/api/shopify-app-remix/guide-future-flags).
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export async function action({ request }: ActionFunctionArgs) {
const { admin } = await authenticate.webhook(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 });
}
import { json, ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export async function action({ request }: ActionFunctionArgs) {
const { admin } = await authenticate.webhook(request);
const response = await admin?.graphql.query<any>({
data: {
query: `#graphql
mutation populateProduct($input: ProductInput!) {
productCreate(input: $input) {
product {
id
}
}
}`,
variables: { input: { title: "Product Name" } },
},
});
const productData = response?.body.data;
return json({ data: productData.data });
}
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { apiVersion } = await authenticate.webhook(request);
return new Response();
};
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { shop } = await authenticate.webhook(request);
return new Response();
};
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { topic } = await authenticate.webhook(request);
switch (topic) {
case "APP_UNINSTALLED":
// Do something when the app is uninstalled.
break;
}
return new Response();
};
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { webhookId } = await authenticate.webhook(request);
return new Response();
};
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { payload } = await authenticate.webhook(request);
return new Response();
};
import { ActionFunctionArgs } from "@remix-run/node";
import { authenticate } from "../shopify.server";
export const action = async ({ request }: ActionFunctionArgs) => {
const { subTopic } = await authenticate.webhook(request);
return new Response();
};