Vendure Webhook 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!
Breaking changes since v7.x
- Check what URL is triggered for what event in your current environment, and note it down somewhere.
- Install the new version, migrate, start the server, and go to
Settings > Webhookin the Admin UI. - Create the hook. You can leave the
Transformerfield blank: the plugin will send an empty post without a transfomer.
Getting started
yarn add vendure-plugin-webhook- Add the
WebhookPluginto your plugins in yourvendure-config.ts:
import { WebhookPlugin } from '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],
}),
}),
];- Run a DB migration to create the custom entities.
- Start the server and assign the permission
SetWebhookto administrators who should be able to configure webhooks. - Go to
settings > webhookto configure webhooks
Custom transformers
Request 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 '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],
});