Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.36 KB

webhooks-configuration.adoc

File metadata and controls

59 lines (35 loc) · 2.36 KB

Webhooks

Taiga comes with an easy third party integration system based on webhooks. Some applications can be integrated with it, and you can configure each one in Taiga.

1. What is a webhook:

A webHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing webHooks will POST a message to a URL when certain things happen.

In other words a webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.

Taiga emits a webhook when

  • a sprint is created, updated or deleted.

  • a user story is created, updated or deleted.

  • a task is created, updated or deleted.

  • an issue is created, updated or deleted.

  • a wiki page is created, updated or deleted.

2. Configure the third party service

First of all, be sure that the service supports the Taiga webhooks and it’s able to understand and process the messages Taiga sends. If we are sure that it’s possible we can start:

  1. Go to your service and search for support about how to enable Taiga webhooks, and do it.

  2. After enabling it, you need to Copy the payload url for the webhook and the secret key.

    • The payload url is the service endpoint that will receive the information sent by Taiga.

    • A secret key is a string (long is better) that is used to encrypt and decrypt a message so that only those who know the key can decrypt and read it.

3. Configure webhooks in Taiga

  • Go to Admin > Integrations > Webhooks.

Webhooks Panel
  • Fill the name, secret key and payload url based on the data provided by your service.

Add a new webhook
  • Save the changes and the webhook will be created.

Webhook created

After creating a webhook you’ll be able to edit, delete, or test if it works properly.

And you can view the history of the calls done.

Webhook history entries list
Webhook history entry details

4. Developing your own integration

If you want to integrate your own system with the Taiga webhooks, you can see the technical documentation about webhooks system.