yarn add @pinelab/vendure-plugin-webhook
to install this plugin.
yarn add @pinelab/vendure-plugin-webhook
to install this plugin.
Triggers an outgoing webhook based on configured events. Events are specified in vendure-config
and webhooks are configured per
channel via the admin UI.
YOu can use this plugin for example to trigger builds when ProductEvents or CollectionEvents occur, or send notifications to external platforms when orders are placed by subscribing to OrderPlacedEvents!
:warning: V7 of this plugin allows you to create multiple webhooks per channel for multiple different events. You have to manually recreate your webhooks after migration! (Don't forget your DB migration):
Settings > Webhook
in the Admin UI.Transformer
field blank: the plugin will send an empty post without a transfomer.WebhookPlugin
to your plugins in your vendure-config.ts
:import { WebhookPlugin } from '@pinelab/vendure-plugin-webhook';
plugins: [
WebhookPlugin.init({
/**
* Optional: 'delay' waits and deduplicates events for 3000ms.
* If 4 events were fired for the same channel within 3 seconds,
* only 1 webhook call will be sent
*/
delay: 3000,
events: [ProductEvent, ProductVariantEvent],
/**
* Optional: A requestTransformer allows you to send custom headers
* and a custom body with your webhook call.
* If no transformers are specified
*/
requestTransformers: [],
}),
AdminUiPlugin.init({
port: 3002,
route: 'admin',
app: compileUiExtensions({
outputPath: path.join(__dirname, '__admin-ui'),
// Add the WebhookPlugin's UI to the admin
extensions: [WebhookPlugin.ui],
}),
}),
];
SetWebhook
to administrators who should be able to configure webhooks.settings > webhook
to configure webhooksRequest transformers are used to create a custom POST body and custom headers for your outgoing webhooks. The example below stringifies the contents of a ProductEvent.
import { Logger, ProductEvent } from '@vendure/core';
import { RequestTransformer } from '@pinelab/vendure-plugin-webhook';
export const stringifyProductTransformer = new RequestTransformer({
name: 'Stringify Product events',
supportedEvents: [ProductEvent],
transform: (event, injector) => {
if (event instanceof ProductEvent) {
return {
body: JSON.stringify(event),
headers: {
'x-custom-header': 'custom-example-header',
'content-type': 'application/json',
},
};
} else {
throw Error(`This transformer is only for ProductEvents!`);
}
},
});
// In your vendure-config's plugin array:
WebhookPlugin.init({
events: [ProductEvent],
requestTransformers: [stringifyProductTransformer],
});