@pinelab/vendure-plugin-webhook 1.5.2 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.6.0 (2026-01-20)
+
+- Allow creation of channel-agnostic webhooks that trigger for all channels.
+- Channel-agnostic webhooks are available to users with the "CreateChannel" permission to prevent leaking data of other channels.
+- BREAKING: requires a DB migration to add the new `channelAgnostic` column.
+
 # 1.5.2 (2025-11-13)
 
 - Documentation update

package/dist/api/api-extension.js

@@ -10,6 +10,7 @@ exports.adminSchema = (0, graphql_tag_1.default) `
     event: String!
     url: String!
     transformerName: String
+    channelAgnostic: Boolean
   }
 
   type Webhook {
@@ -17,6 +18,7 @@ exports.adminSchema = (0, graphql_tag_1.default) `
     event: String!
     url: String!
     requestTransformer: WebhookRequestTransformer
+    channelAgnostic: Boolean!
   }
 
   type WebhookRequestTransformer {

package/dist/api/webhook.entity.d.ts

@@ -9,4 +9,9 @@ export declare class Webhook extends VendureEntity {
     url: string;
     event: string;
     transformerName?: string;
+    /**
+     * When set to true, this webhook is available for all channels.
+     * Otherwise, it is only available for the channel specified in the `channelId` column.
+     */
+    channelAgnostic: boolean;
 }

package/dist/api/webhook.entity.js

@@ -19,6 +19,11 @@ const core_1 = require("@vendure/core");
 let Webhook = class Webhook extends core_1.VendureEntity {
     constructor(input) {
         super(input);
+        /**
+         * When set to true, this webhook is available for all channels.
+         * Otherwise, it is only available for the channel specified in the `channelId` column.
+         */
+        this.channelAgnostic = false;
     }
 };
 exports.Webhook = Webhook;
@@ -38,6 +43,10 @@ __decorate([
     (0, typeorm_1.Column)({ nullable: true }),
     __metadata("design:type", String)
 ], Webhook.prototype, "transformerName", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: false }),
+    __metadata("design:type", Boolean)
+], Webhook.prototype, "channelAgnostic", void 0);
 exports.Webhook = Webhook = __decorate([
     (0, typeorm_1.Entity)(),
     __metadata("design:paramtypes", [Object])

package/dist/api/webhook.resolver.d.ts

@@ -1,8 +1,8 @@
 import { PermissionDefinition, RequestContext } from '@vendure/core';
-import { WebhookService } from './webhook.service';
 import { Webhook, WebhookInput, WebhookRequestTransformer } from '../generated/graphql-types';
-import { Webhook as WebhookEntity } from './webhook.entity';
 import { RequestTransformer } from './request-transformer';
+import { Webhook as WebhookEntity } from './webhook.entity';
+import { WebhookService } from './webhook.service';
 export declare const webhookPermission: PermissionDefinition;
 /**
  * Graphql resolvers for retrieving and updating webhook for channel

package/dist/api/webhook.resolver.js

@@ -16,8 +16,8 @@ exports.WebhookRequestTransformerResolver = exports.WebhookResolver = exports.we
 exports.mapToGraphqlTransformer = mapToGraphqlTransformer;
 const graphql_1 = require("@nestjs/graphql");
 const core_1 = require("@vendure/core");
-const webhook_service_1 = require("./webhook.service");
 const webhook_entity_1 = require("./webhook.entity");
+const webhook_service_1 = require("./webhook.service");
 // Permission needs to be defined first
 exports.webhookPermission = new core_1.PermissionDefinition({
     name: 'SetWebhook',
@@ -31,6 +31,20 @@ let WebhookResolver = class WebhookResolver {
         this.webhookService = webhookService;
     }
     async setWebhooks(ctx, webhooks) {
+        const currentWebhooks = await this.webhookService.getAllWebhooks(ctx);
+        const newWebhooks = webhooks.filter((webhook) => !currentWebhooks.some((w) => w.channelAgnostic &&
+            w.event === webhook.event &&
+            w.url === webhook.url));
+        // Check if any of the new webhooks are being set as channel-agnostic
+        const hasChannelAgnosticWebhook = newWebhooks.some((webhook) => webhook.channelAgnostic === true);
+        if (hasChannelAgnosticWebhook) {
+            // Check if the current user has the "CreateChannel" permission
+            const channelPermissions = ctx.session?.user?.channelPermissions || [];
+            const hasPermission = channelPermissions.some((perm) => perm.permissions?.includes(core_1.Permission.CreateChannel));
+            if (!hasPermission) {
+                throw new core_1.ForbiddenError();
+            }
+        }
         return this.webhookService.saveWebhooks(ctx, webhooks);
     }
     async webhooks(ctx) {

package/dist/api/webhook.service.js

@@ -82,9 +82,12 @@ let WebhookService = class WebhookService {
      * Get all configured webhooks for current channel
      */
     async getAllWebhooks(ctx) {
-        return this.connection
-            .getRepository(ctx, webhook_entity_1.Webhook)
-            .find({ where: { channelId: String(ctx.channelId) } });
+        return this.connection.getRepository(ctx, webhook_entity_1.Webhook).find({
+            where: [
+                // Get channel-specific webhooks only
+                { channelId: String(ctx.channelId) },
+            ],
+        });
     }
     /**
      * Get configured webhooks for given Event
@@ -92,7 +95,12 @@ let WebhookService = class WebhookService {
     async getWebhooksForEvent(event) {
         const eventName = event.constructor.name;
         return this.connection.getRepository(event.ctx, webhook_entity_1.Webhook).find({
-            where: { channelId: String(event.ctx.channelId), event: eventName },
+            where: [
+                // Get channel-specific webhooks
+                { channelId: String(event.ctx.channelId), event: eventName },
+                // Or, get channel-agnostic webhooks
+                { channelAgnostic: true, event: eventName },
+            ],
         });
     }
     /**
@@ -109,6 +117,7 @@ let WebhookService = class WebhookService {
             url: input.url,
             event: input.event,
             transformerName: input.transformerName ?? undefined,
+            channelAgnostic: input.channelAgnostic ?? false,
         }));
         await repository.save(webhooks);
         return this.getAllWebhooks(ctx);

package/dist/generated/graphql-types.d.ts

@@ -41,12 +41,14 @@ export type Query = {
 };
 export type Webhook = {
     __typename?: 'Webhook';
+    channelAgnostic: Scalars['Boolean'];
     event: Scalars['String'];
     id: Scalars['ID'];
     requestTransformer?: Maybe<WebhookRequestTransformer>;
     url: Scalars['String'];
 };
 export type WebhookInput = {
+    channelAgnostic?: InputMaybe<Scalars['Boolean']>;
     event: Scalars['String'];
     transformerName?: InputMaybe<Scalars['String']>;
     url: Scalars['String'];
@@ -66,6 +68,7 @@ export type SetWebhooksMutation = {
         id: number | string;
         event: string;
         url: string;
+        channelAgnostic: boolean;
         requestTransformer?: {
             __typename?: 'WebhookRequestTransformer';
             name: string;
@@ -83,6 +86,7 @@ export type WebhooksQuery = {
         id: number | string;
         event: string;
         url: string;
+        channelAgnostic: boolean;
         requestTransformer?: {
             __typename?: 'WebhookRequestTransformer';
             name: string;

package/dist/generated/graphql-types.js

@@ -15,6 +15,7 @@ exports.SetWebhooks = (0, graphql_tag_1.default) `
       supportedEvents
     }
     url
+    channelAgnostic
   }
 }
     `;
@@ -28,6 +29,7 @@ exports.Webhooks = (0, graphql_tag_1.default) `
       supportedEvents
     }
     url
+    channelAgnostic
   }
 }
     `;

package/dist/ui/graphql-types.ts

@@ -39,6 +39,7 @@ export type Query = {
 
 export type Webhook = {
   __typename?: 'Webhook';
+  channelAgnostic: Scalars['Boolean'];
   event: Scalars['String'];
   id: Scalars['ID'];
   requestTransformer?: Maybe<WebhookRequestTransformer>;
@@ -46,6 +47,7 @@ export type Webhook = {
 };
 
 export type WebhookInput = {
+  channelAgnostic?: InputMaybe<Scalars['Boolean']>;
   event: Scalars['String'];
   transformerName?: InputMaybe<Scalars['String']>;
   url: Scalars['String'];
@@ -62,12 +64,12 @@ export type SetWebhooksMutationVariables = Exact<{
 }>;
 
 
-export type SetWebhooksMutation = { __typename?: 'Mutation', setWebhooks: Array<{ __typename?: 'Webhook', id: number | string, event: string, url: string, requestTransformer?: { __typename?: 'WebhookRequestTransformer', name: string, supportedEvents: Array<string> } | null }> };
+export type SetWebhooksMutation = { __typename?: 'Mutation', setWebhooks: Array<{ __typename?: 'Webhook', id: number | string, event: string, url: string, channelAgnostic: boolean, requestTransformer?: { __typename?: 'WebhookRequestTransformer', name: string, supportedEvents: Array<string> } | null }> };
 
 export type WebhooksQueryVariables = Exact<{ [key: string]: never; }>;
 
 
-export type WebhooksQuery = { __typename?: 'Query', webhooks: Array<{ __typename?: 'Webhook', id: number | string, event: string, url: string, requestTransformer?: { __typename?: 'WebhookRequestTransformer', name: string, supportedEvents: Array<string> } | null }> };
+export type WebhooksQuery = { __typename?: 'Query', webhooks: Array<{ __typename?: 'Webhook', id: number | string, event: string, url: string, channelAgnostic: boolean, requestTransformer?: { __typename?: 'WebhookRequestTransformer', name: string, supportedEvents: Array<string> } | null }> };
 
 export type AvailableWebhookEventsQueryVariables = Exact<{ [key: string]: never; }>;
 
@@ -90,6 +92,7 @@ export const SetWebhooks = gql`
       supportedEvents
     }
     url
+    channelAgnostic
   }
 }
     `;
@@ -103,6 +106,7 @@ export const Webhooks = gql`
       supportedEvents
     }
     url
+    channelAgnostic
   }
 }
     `;

package/dist/ui/queries.ts

@@ -10,6 +10,7 @@ export const setWebhooksMutation = gql`
         supportedEvents
       }
       url
+      channelAgnostic
     }
   }
 `;
@@ -24,6 +25,7 @@ export const getWebhooksQuery = gql`
         supportedEvents
       }
       url
+      channelAgnostic
     }
   }
 `;

package/dist/ui/webhook.component.html

@@ -39,7 +39,7 @@
                 <select clrSelect [(ngModel)]="eventName">
                   <option value="{{ undefined }}">--select---</option>
                   <option
-                    *ngFor="let event of filteredWeebhookEvents"
+                    *ngFor="let event of filteredWebhookEvents"
                     [value]="event"
                   >
                     {{ event }}
@@ -55,6 +55,10 @@
                   [(ngModel)]="url"
                 />
               </li>
+              <li class="list-group-item" *vdrIfPermissions="['CreateChannel']">
+                <h4 class="card-title">Trigger for all channels</h4>
+                <input type="checkbox" [(ngModel)]="channelAgnostic" />
+              </li>
             </ul>
           </div>
         </div>
@@ -83,6 +87,7 @@
     <vdr-dt-column>Event</vdr-dt-column>
     <vdr-dt-column>Request Transformer</vdr-dt-column>
     <vdr-dt-column>URL</vdr-dt-column>
+    <vdr-dt-column>Trigger for all channels</vdr-dt-column>
     <vdr-dt-column></vdr-dt-column>
 
     <ng-template let-webhook="item">
@@ -95,6 +100,9 @@
       <td class="left align-middle">
         {{ webhook.url }}
       </td>
+      <td class="left align-middle">
+        {{ webhook.channelAgnostic ? 'Yes' : 'No' }}
+      </td>
       <td>
         <vdr-dropdown>
           <button type="button" class="btn btn-link btn-sm" vdrDropdownTrigger>
@@ -105,7 +113,7 @@
             <button
               type="button"
               class="delete-button"
-              (click)="deleteWeebhook(webhook.id)"
+              (click)="deleteWebhook(webhook.id)"
               vdrDropdownItem
             >
               <clr-icon shape="trash" class="is-danger"></clr-icon>

package/dist/ui/webhook.component.ts

@@ -25,9 +25,10 @@ export class WebhookComponent implements OnInit {
   eventName: string | undefined;
   requestTransformerName: string | undefined;
   url: string | undefined;
+  channelAgnostic: boolean = false;
   showMessage = false;
-  availableWeebhookEvents: string[] = [];
-  filteredWeebhookEvents: string[] = [];
+  availableWebhookEvents: string[] = [];
+  filteredWebhookEvents: string[] = [];
   avaiabelWebhookRequestTransformers: WebhookRequestTransformer[] = [];
 
   constructor(
@@ -41,7 +42,7 @@ export class WebhookComponent implements OnInit {
     this.dataService
       .query(getAvailableWebhookEventsQuery)
       .single$.subscribe((e: any) => {
-        this.filteredWeebhookEvents = this.availableWeebhookEvents =
+        this.filteredWebhookEvents = this.availableWebhookEvents =
           e.availableWebhookEvents;
       });
     this.dataService.query(getWebhooksQuery).single$.subscribe((s: any) => {
@@ -69,6 +70,7 @@ export class WebhookComponent implements OnInit {
     this.eventName = '';
     this.requestTransformerName = '';
     this.url = '';
+    this.channelAgnostic = false;
     this.changeDetector.detectChanges();
   }
 
@@ -87,12 +89,14 @@ export class WebhookComponent implements OnInit {
                 event: w.event,
                 transformerName: w.requestTransformer?.name,
                 url: w.url,
+                channelAgnostic: w.channelAgnostic,
               };
             }),
             {
               event: this.eventName,
               transformerName: this.requestTransformerName,
               url: this.url,
+              channelAgnostic: this.channelAgnostic,
             },
           ],
         })
@@ -107,7 +111,7 @@ export class WebhookComponent implements OnInit {
     }
   }
 
-  deleteWeebhook(id: number) {
+  deleteWebhook(id: number) {
     this.webhooks = this.webhooks.filter((w: Webhook) => w.id != id);
     this.changeDetector.detectChanges();
     this.dataService
@@ -118,6 +122,7 @@ export class WebhookComponent implements OnInit {
               event: w.event,
               transformerName: w.requestTransformer?.name,
               url: w.url,
+              channelAgnostic: w.channelAgnostic,
             };
           }),
         ],
@@ -130,19 +135,19 @@ export class WebhookComponent implements OnInit {
 
   requestTransformerSelected(setRequestTransformerName?: string) {
     if (setRequestTransformerName) {
-      this.filteredWeebhookEvents =
+      this.filteredWebhookEvents =
         this.avaiabelWebhookRequestTransformers.find(
           (v) => v.name === this.requestTransformerName
         )?.supportedEvents ?? [];
     } else if (this.requestTransformerName) {
-      this.filteredWeebhookEvents =
+      this.filteredWebhookEvents =
         this.avaiabelWebhookRequestTransformers.find(
           (v) => v.name === this.requestTransformerName
         )?.supportedEvents ?? [];
     } else {
-      this.filteredWeebhookEvents = this.availableWeebhookEvents;
+      this.filteredWebhookEvents = this.availableWebhookEvents;
     }
-    this.eventName = this.filteredWeebhookEvents.find(
+    this.eventName = this.filteredWebhookEvents.find(
       (v) => v === this.eventName
     );
     this.changeDetector.detectChanges();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinelab/vendure-plugin-webhook",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Call webhooks based on configured events from Vendure",
   "author": "Martijn van de Brug <martijn@pinelab.studio>",
   "homepage": "https://plugins.pinelab.studio/",
@@ -23,5 +23,5 @@
     "test": "vitest run",
     "lint": "echo 'No linting configured'"
   },
-  "gitHead": "ba4e499e13892b029fac2aa29082c03ec8032249"
+  "gitHead": "9249d84c769819b980f28dd39197d3e5fa4539cc"
 }