Administering Keen
Incoming webhooks
Chapter 22 of 30
Incoming webhooks
A webhook lets another system push evidence to Keen as JSON. A provider definition says how that JSON becomes an event, and a shared secret header authenticates the sender.
- Define the provider in
config/webhooks.yml, including its secret header and the server-side secret reference. - Configure its authentication before supplying the URL to an external sender.
- Confirm the sender's response handling and inspect a test event before enabling routine delivery.
The endpoint is public-facing. The API authenticates it independently of browser sessions, so never expose an unauthenticated endpoint merely because the application's normal pages require login. Preserve timestamp and replay checks and rate limiting, and restrict ingress at the proxy where practical.
For SLA and other measurements, follow effectiveness-measure webhook setup; the measurement editor provides Python and curl payload examples for the selected measurement.