--- title: Webhook slug: docs/webhook docTags: createdAt: 2024-04-17T19:24:54.657Z --- :::hint{type="info"} This feature is only available with TruffleHog Enterprise. [Contact us](https://trufflesecurity.com/contact) to learn more. ::: Webhook notifiers allow for integrations which subscribe to found secret notifications. When a new secret is found, an HTTP POST payload will be sent to the webhook’s configured URL. Webhooks can be secured by using a token to generate and verify a signature of the payload. For platforms such as Sumo Logic that do not accept X-Hub-Signature headers natively, then you may need to provide a pre-signed URL instead. This allows you to authenticate without a token, and the token: parameter can be removed from your config.yml. ## Scanner Configuration ```yaml notifiers: - connection: '@type': type.googleapis.com/notifiers.Webhook token: secret_token url: https://example.trufflesec.com:8081/webhook notifyOnRotation: false name: webhook secrets notifications # sourcesToNotify can also be set to ALL to receive # all notifications sourcesToNotify: SOURCES_IN_THIS_CONFIG type: NOTIFIER_TYPE_WEBHOOK heartbeatInterval: interval_in_hours ``` ### Options | Key | Description | Required | | ------------------ | ------------------------------------------------------------------------------------------------------- | -------- | | url | The webhook endpoint to send the notification to | Yes | | token | Token to generate signature for webhook | No | | notifyOnRotation | Set to `true` to send follow-up webhook notification when secret is rotated | No | | signatureMethod | `sha256` or `hmac-sha256`. Default: `sha256` | No | | base64EncodedToken | Set to true if provided `token` is base64 encoded | No | | heartbeatInterval | One of: 0, 1, 2, 6, 12, 24. Set to 0 to disable heartbeats, set to any other value to enable heartbeats | No | ## Tokens The signature is sent using in the X-Hub-Signature header. To verify the signature matches the payload, generate a SHA256 hash of the payload body prefixed with the token string. :::BlockQuote X-HUB-SIGNATURE:5f246d1f78c832eee4d9b453742476a743a1c7fe73454b6b432b26868525423f \> BODY='\{"source\_type":"SourceType\_SOURCE\_TYPE\_GIT",...}' \> TOKEN="mySecretToken" \> echo -n "${TOKEN}${BODY}" | sha256sum 5f246d1f78c832eee4d9b453742476a743a1c7fe73454b6b432b26868525423f ::: ## Example payload body by source :::CodeblockTabs Filesystem ```yaml { "SourceType": "SOURCE_TYPE_FILESYSTEM", "Metadata": { "Data": { "Filesystem": { "file": "/Users/hrich/go/src/github.com/org/repo/file" } } }, "SecretType": "Github", "Secret": "SOMESECRET", "Verified": false } ``` Microsoft Teams ```yaml { "SourceType": "SOURCE_TYPE_TEAMS", "Metadata": { "Data": { "Teams": { "channelID": "channel-1", "channelName": "some channel", "timestamp": "2020-05-01T00:00:00Z", "userId": "user-1", "link": "https://teams.microsoft.com/l/message/19:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "file": "file-1", "email": "test@microsoft.com" } } }, "SecretType": "Github", "Secret": "SOMESECRET", "Verified": false } ``` GitHub ```yaml { "SourceType": "SOURCE_TYPE_GITHUB", "Metadata": { "Data": { "Github": { "link": "https://github.com/org/repo/blob/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/file", "username": "user-1", "repository": "repo-1", "commit": "ae3e9d0f0516d52113386c1e75032536143a241c", "email": "test@example.com", "file": "file.txt", "timestamp": "2020-05-01T00:00:00Z", "line": 42 } } }, "SecretType": "Github", "Secret": "OTHERSECRET", "Verified": true } ``` JIRA ```yaml { "SourceType": "SOURCE_TYPE_JIRA", "Metadata": { "Data": { "Jira": { "issue": "issue-1", "author": "user-1", "location": "https://ourbusiness.atlassian.net/browse/issue-1", "email": "user-1@atlassian.net", "timestamp": "2020-05-01T00:00:00Z" } } }, "SecretType": "Github", "Secret": "SOMESECRET", "Verified": false } ``` BitBucket ```yaml { "SourceType": "SOURCE_TYPE_BITBITBUCKET", "Metadata": { "Data": { "Bitbucket": { "file": "file-1", "repository": "repo-1", "workspace": "workspace-1", "snippetId": "snippet-1", "title": "title-1", "commit": "ae3e9d0f0516d52113386c1e75032536143a241c", "email": "user-1@atlassian.net", "link": "https://bitbucket.org/workspace-1/repo-1/src/ae3e9d0f0516d52113386c1e75032536143a241c/file-1", "timestamp": "2020-05-01T00:00:00Z", "line": 42 } } }, "SecretType": "Github", "Secret": "SOMESECRET", "Verified": false } ``` Confluence ```yaml { "SourceType": "SOURCE_TYPE_CONFLUENCE", "Metadata": { "Data": { "Jira": { "page": "page-1", "space": "space-1", "version": "version-1", "link": "http://confluence.example.com/pages/viewpage.action?pageId=page-1", "email": "user-1@atlassian.net", "timestamp": "2020-05-01T00:00:00Z" } } }, "SecretType": "Github", "Secret": "OTherSecret", "Verified": true } ``` GitLab ```yaml { "SourceType": "SOURCE_TYPE_GITLAB", "Metadata": { "Data": { "Gitlab": { "file": "file-1", "link": "https://gitlab.com/org/repo/blob/ae3e9d0f0516d52113386c1e75032536143a241c/file-1", "repository": "repo-1", "line": 42, "timestamp": "2020-05-01T00:00:00Z", "commit": "ae3e9d0f0516d52113386c1e75032536143a241c", "email": "test@example.com" } } }, "SecretType": "Github", "Secret": "SOMESECRET", "Verified": false } ``` Slack ```yaml { "SourceType": "SOURCE_TYPE_SLACK", "Metadata": { "Data": { "Slack": { "channelID": "channel-1", "channelName": "some channel", "timestamp": "2020-05-01T00:00:00Z", "userId": "user-1", "link": "https://slack.com/app_redirect?channel=channel-1", "file": "file-1", "email": "test@slack.com" } } }, "SecretType": "Github", "Secret": "SOMESECRET42", "Verified": true } ``` :::