Beskos

Reference

Channel webhooks

Posting messages into a chat channel from an external service.

Updated:

Contents

A webhook is a URL that converts an HTTP POST request into a message in a single channel. It is used to deliver alerts, build results and monitoring output into Chat.

Creating a webhook

Open the channel → Settings → Webhooks → Add. The name assigned is displayed as the author of each message posted through it.

Creation returns a URL containing a token. The token constitutes the authorisation for the channel and should be handled as a credential. A compromised token can be deleted.

Posting a message

A JSON body containing a text field.

curl -X POST https://app.beskos.com/api/public/chat/hook/<token> \
  -H 'Content-Type: application/json' \
  -d '{"text": "Deploy finished: build 1284 is live"}'

Rate limits

The endpoint is rate-limited per source address, as it is reachable without authentication. Standard alerting volumes are not affected.