Skip to content

Set up webhooks

A webhook lets another system react to what happens on your boards. Each time something you chose changes, Studio sends a signed message to an address you give it, and tries again with a growing delay when that fails. Use one to start a pipeline when a slice is ready, post to a chat, or keep another tool in step.

  • You are a maintainer of the organization.
  • You have an https address on a public host that can receive the message. Addresses inside a private network and plain http are refused.
  1. Open Organization settings and select Webhooks.

  2. Select Add webhook. The Add a webhook dialog opens.

  3. Enter a Name for your own reference, such as CI pipeline.

  4. Enter the Address Studio should post to.

  5. Narrow what it listens to, or leave everything on Any:

    • Board: one board, or any board.
    • Kinds of board: which kinds of board to include.
    • What changed: the kinds of item, such as a slice or a comment.
    • How it changed: added, renamed, removed, moved, updated, status changed, commented or restored.
  6. Select Save.

  7. Copy the Signing secret now. It is shown only once.

The Webhooks page with the Add webhook button
Each webhook is listed here, with its deliveries.

A webhook only receives changes that happen after you add it.

Select Deliveries on a webhook to see what was sent. Each one shows Delivered, Retrying (with the attempt and the time of the next one) or Given up. Hide deliveries closes the list. A new webhook says Nothing has been delivered yet. until something it listens to changes.

  • Edit changes the name, address or what it listens to.
  • Rotate secret signs deliveries with a new secret from now on. Give the new secret to the receiver straight away.
  • Remove stops all deliveries to it.

What a message looks like, how to check its signature and the retry schedule are in the webhooks reference for developers.