Symon
05979a460f
Adds optional project, board, and acting-user scope to each webhook so events from a specific board or project can be routed to a single endpoint without an external automation tool in the middle (closes #1457). A webhook now fires for an event only when every set scope matches: empty scope still means "fire for everything", keeping existing webhooks working unchanged. Scope filtering is centralized in the sendWebhooks helper, which auto-derives projectId/boardId from the event payload, so existing call sites are untouched.
173 lines
4.6 KiB
JavaScript
173 lines
4.6 KiB
JavaScript
/*!
|
|
* Copyright (c) 2024 PLANKA Software GmbH
|
|
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
|
*/
|
|
|
|
/**
|
|
* @swagger
|
|
* /webhooks:
|
|
* post:
|
|
* summary: Create webhook
|
|
* description: Creates a webhook. Requires admin privileges.
|
|
* tags:
|
|
* - Webhooks
|
|
* operationId: createWebhook
|
|
* requestBody:
|
|
* required: true
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - name
|
|
* - url
|
|
* properties:
|
|
* projectId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: Optional project scope
|
|
* example: "1357158568008091264"
|
|
* boardId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: Optional board scope
|
|
* example: "1357158568008091264"
|
|
* userId:
|
|
* type: string
|
|
* nullable: true
|
|
* description: Optional acting-user scope
|
|
* example: "1357158568008091264"
|
|
* name:
|
|
* type: string
|
|
* maxLength: 128
|
|
* description: Name/title of the webhook
|
|
* example: Webhook Updates
|
|
* url:
|
|
* type: string
|
|
* format: url
|
|
* maxLength: 2048
|
|
* description: URL endpoint for the webhook
|
|
* example: https://service.example.com/planka
|
|
* accessToken:
|
|
* type: string
|
|
* maxLength: 512
|
|
* nullable: true
|
|
* description: Access token for webhook authentication
|
|
* example: secret_token_123
|
|
* events:
|
|
* type: string
|
|
* maxLength: 2048
|
|
* nullable: true
|
|
* description: Comma-separated list of events that trigger the webhook
|
|
* example: cardCreate,cardUpdate,cardDelete
|
|
* excludedEvents:
|
|
* type: string
|
|
* maxLength: 2048
|
|
* nullable: true
|
|
* description: Comma-separated list of events excluded from the webhook
|
|
* example: userCreate,userUpdate,userDelete
|
|
* responses:
|
|
* 200:
|
|
* description: Webhook created successfully
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - item
|
|
* properties:
|
|
* item:
|
|
* $ref: '#/components/schemas/Webhook'
|
|
* 400:
|
|
* $ref: '#/components/responses/ValidationError'
|
|
* 401:
|
|
* $ref: '#/components/responses/Unauthorized'
|
|
* 409:
|
|
* $ref: '#/components/responses/Conflict'
|
|
*/
|
|
|
|
const { isUrl } = require('../../../utils/validators');
|
|
const { idInput } = require('../../../utils/inputs');
|
|
|
|
const Errors = {
|
|
LIMIT_REACHED: {
|
|
limitReached: 'Limit reached',
|
|
},
|
|
};
|
|
|
|
module.exports = {
|
|
inputs: {
|
|
projectId: {
|
|
...idInput,
|
|
allowNull: true,
|
|
},
|
|
boardId: {
|
|
...idInput,
|
|
allowNull: true,
|
|
},
|
|
userId: {
|
|
...idInput,
|
|
allowNull: true,
|
|
},
|
|
name: {
|
|
type: 'string',
|
|
maxLength: 128,
|
|
required: true,
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
maxLength: 2048,
|
|
custom: isUrl,
|
|
required: true,
|
|
},
|
|
accessToken: {
|
|
type: 'string',
|
|
isNotEmptyString: true,
|
|
maxLength: 512,
|
|
allowNull: true,
|
|
},
|
|
events: {
|
|
type: 'string',
|
|
isNotEmptyString: true,
|
|
maxLength: 2048,
|
|
allowNull: true,
|
|
},
|
|
excludedEvents: {
|
|
type: 'string',
|
|
isNotEmptyString: true,
|
|
maxLength: 2048,
|
|
allowNull: true,
|
|
},
|
|
},
|
|
|
|
exits: {
|
|
limitReached: {
|
|
responseType: 'conflict',
|
|
},
|
|
},
|
|
|
|
async fn(inputs) {
|
|
const { currentUser } = this.req;
|
|
|
|
const values = _.pick(inputs, ['projectId', 'boardId', 'userId', 'name', 'url', 'accessToken']);
|
|
const events = inputs.events && inputs.events.split(',');
|
|
const excludedEvents = inputs.excludedEvents && inputs.excludedEvents.split(',');
|
|
|
|
const webhook = await sails.helpers.webhooks.createOne
|
|
.with({
|
|
values: {
|
|
...values,
|
|
events,
|
|
excludedEvents,
|
|
},
|
|
actorUser: currentUser,
|
|
request: this.req,
|
|
})
|
|
.intercept('limitReached', () => Errors.LIMIT_REACHED);
|
|
|
|
return {
|
|
item: webhook,
|
|
};
|
|
},
|
|
};
|