@shopify/shopify-api
Version:
Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks
75 lines • 2.91 kB
TypeScript
import { ConfigInterface } from '../base-types';
import { addHandlers, getTopicsAdded, getHandlers } from './registry';
import { register } from './register';
import { process } from './process';
import { validateFactory } from './validate';
interface Webhooks {
/**
* Add shop-specific webhook handlers to the library registry,
* allowing you to register webhooks with Shopify and process HTTP webhook requests from Shopify.
* In most cases, you should use app-specific webhooks:
*
* {@link https://shopify.dev/docs/apps/build/webhooks/subscribe#app-specific-vs-shop-specific-subscriptions}
*
* If you use only app-specific webhooks, you do not need to use `addHandlers`.
*
*/
addHandlers: ReturnType<typeof addHandlers>;
/**
* Fetches all topics that were added to the registry.
*
* In most cases, you should use app-specific webhooks:
*
* {@link https://shopify.dev/docs/apps/build/webhooks/subscribe#app-specific-vs-shop-specific-subscriptions}
*
* If you use only app-specific webhooks, you do not need to use `getTopicsAdded`.
*
*/
getTopicsAdded: ReturnType<typeof getTopicsAdded>;
/**
* Fetches the configured handlers for shop-specific webhooks for the given topic.
*
* In most cases, you should use app-specific webhooks:
*
* {@link https://shopify.dev/docs/apps/build/webhooks/subscribe#app-specific-vs-shop-specific-subscriptions}
*
* If you use only app-specific webhooks, you do not need to use `getHandlers`.
*
*/
getHandlers: ReturnType<typeof getHandlers>;
/**
* Registers a webhook handler for a given topic.
*
* In most cases, you should use app-specific webhooks:
*
* {@link https://shopify.dev/docs/apps/build/webhooks/subscribe#app-specific-vs-shop-specific-subscriptions}
*
* If you use only app-specific webhooks, you do not need to use `register`.
*
*/
register: ReturnType<typeof register>;
/**
* Processes a webhook request.
*
* In most cases, you should use app-specific webhooks:
*
* {@link https://shopify.dev/docs/apps/build/webhooks/subscribe#app-specific-vs-shop-specific-subscriptions}
*
* If you use only app-specific webhooks, you do not need to use `process`.
*
*/
process: ReturnType<typeof process>;
/**
* Validates an incoming request for `Http` handlers.
*
* If the call is invalid, it will return a `valid` field set to `false`.
*
* `validate` can be used to validate app-specific and shop-specific webhook requests.
*
*/
validate: ReturnType<typeof validateFactory>;
}
export declare function shopifyWebhooks(config: ConfigInterface): Webhooks;
export type ShopifyWebhooks = ReturnType<typeof shopifyWebhooks>;
export {};
//# sourceMappingURL=index.d.ts.map