Add webhooks for main events

[BenoitSerrano]

Is this a feature for the backend or frontend?

Backend, Frontend

What would you like?

I'd like to be able to subscribe to webhooks linked to events such as :

• a card has been created
• a comment has been posted
• etc.

Why is this needed?

I use Planka to create a "classified ads" marketplace, and I want to notify my users that an ad has been posted

Other information

No response

[meltyshev]

Hi! This is already possible via configuring WEBHOOKS environment variable:

WEBHOOKS='[{
  "url": "http://localhost:3001",
  "accessToken": "notaccesstoken",
  "events": ["cardCreate", "cardUpdate", "cardDelete"],
  "excludedEvents": ["notificationCreate", "notificationUpdate"]
}]'

[BenoitSerrano]

Oh! Thank you!
I couldn't find it in the documentation. Is it written somewhere? Is there any specs on how the access token will be used (bearer token, x-api-key,...) ?

[meltyshev]

It doesn't seem to be in the docs yet :(

The accessToken will be sent as Authorization: Bearer [accessToken], and all webhooks are sent as POST requests.

Unfortunately, the incoming data hasn't been described yet either, but you can find the general data structure here:

planka/server/api/helpers/utils/send-webhooks.js

Line 104 in c8b3cba

async function sendWebhook(webhook, event, data, prevData, user) {

.