Notifying external systems using webhooks

You can notify your backend systems about events that occurred in Portfoleon using webhooks. To get started, create an automation rule and select Webhook as the action.

In the Webhook configuration you need to specify two parameters:

Parameter Function
URL The URL of your webhook
Secret A value of the secret parameter

When the rule condition is met Portfoleon will send a POST request to the webhook URL. The request body will contain WorkItemBase model with one additional field secret, which will contain the value that you specified in the rule parameters.

Your webhook must process the request within 500ms and return 2xx status in case of success or any other status in case of failure.