mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-17 11:18:16 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
54 lines
2.0 KiB
Plaintext
54 lines
2.0 KiB
Plaintext
---
|
|
title: "Webhooks"
|
|
description: "Learn the fundamentals of KMS webhooks."
|
|
---
|
|
|
|
Webhooks can be used to trigger changes to your integrations when secrets are modified, providing smooth integration with other third-party applications.
|
|
|
|
|
|
|
|
To create a webhook for a particular project, go to `Project Settings > Webhooks`.
|
|
|
|
KMS supports two webhook types - General and Slack. If you need to integrate with Slack, use the Slack type with an [Incoming Webhook](https://api.slack.com/messaging/webhooks). When creating a webhook, you can specify an environment and folder path to trigger only specific integrations.
|
|
|
|
|
|
|
|
## Secret Key Verification
|
|
|
|
A secret key is a way for users to verify that a webhook request was sent by KMS and is intended for the correct integration.
|
|
|
|
When you provide a secret key, KMS will sign the payload of the webhook request using the key and attach a header called `x-kms-signature` to the request with a payload.
|
|
|
|
The header will be in the format `t=<timestamp>;<signature>`. You can then generate the signature yourself by generating a SHA256 hash of the payload with the secret key that you know.
|
|
|
|
If the signature in the header matches the signature that you generated, then you can be sure that the request was sent by KMS and is intended for your integration. The timestamp in the header ensures that the request is not replayed.
|
|
|
|
### Webhook Payload Format
|
|
|
|
```json
|
|
{
|
|
"event": "secrets.modified",
|
|
"project": {
|
|
"workspaceId": "the workspace id",
|
|
"environment": "project environment",
|
|
"secretPath": "project folder path"
|
|
},
|
|
"timestamp": ""
|
|
}
|
|
```
|
|
|
|
```json
|
|
{
|
|
"event": "secrets.reminder-expired",
|
|
"project": {
|
|
"workspaceId": "the workspace id",
|
|
"environment": "project environment",
|
|
"secretPath": "project folder path",
|
|
"secretName": "name of the secret",
|
|
"secretId": "id of the secret",
|
|
"reminderNote": "reminder note of the secret"
|
|
},
|
|
"timestamp": ""
|
|
}
|
|
```
|