Skip to main content
Webhooks · API docs

AI pipeline webhooks for Slack and Teams

Volath sends AI pipeline webhooks for Slack and Teams. Report what happens in a project to other tools as signed JSON, control Volath from Slack or Teams with two-way Chat-Ops, and manage the webhooks through the API.

Benefits

What you get

Webhooks

  • Connect Volath to the tools your team already uses.
  • Verify that an event really came from Volath.
  • Create tickets and approve or reject held steps from Slack or Teams.

API docs

  • Script Volath or connect other tools through its API.

How it works

How it works

It runs on your own machine. Your code, tickets and settings live in a local SQLite database, or in your own MySQL or MariaDB.

Webhooks

  1. In Project settings › Webhooks, add a URL, pick the events and optionally a secret.

  2. Events: ticket.status_changed, pr.opened, ci.failed, deploy.finished, budget.exceeded, approval.requested, ticket.updated, ticket.deleted, ticket.timeline, ticket.activity, ai.job and notification.

  3. Each event is sent as a JSON POST with the header X-Volath-Event. With a secret, it also carries X-Volath-Signature: sha256=<HMAC-SHA256 of the raw body>.

  4. A receiver that is down is tried again twice.

  5. Set Send as to Slack or Teams for a readable message instead of JSON, and use Test to check it.

  6. Add the Slack signing secret or the Teams security token to make it two-way Chat-Ops: create, status, approve and reject from the chat, plus Approve and Reject buttons on Slack approval messages.

  7. Webhooks can also be managed through the API at /api/webhooks.

API docs

  1. Open /api/docs on the address of your local Volath.

  2. The documentation is OpenAPI, generated from the NestJS decorators at build time.

Example

Send ci.failed and approval.requested events to a Slack channel by setting Send as to Slack.

Take your next ticket from idea to merged code

It runs on your own machine. Your code, tickets and settings live in a local SQLite database, or in your own MySQL or MariaDB.

Back to all Volath features · Extend Volath with plugins