Skip to content

Commit ca3f79f

Browse files
jjarmocdavidstahelisubatoi
authored
Update best-practices-for-using-webhooks.md (#53195)
Co-authored-by: David Staheli <[email protected]> Co-authored-by: Ben Ahmady <[email protected]>
1 parent 4aa3bb9 commit ca3f79f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

content/webhooks/using-webhooks/best-practices-for-using-webhooks.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ You should only subscribe to the webhook events that you need. This will reduce
1616

1717
## Use a webhook secret
1818

19-
You should set a webhook secret for your webhook and verify that the signature of each webhook delivery matches the secret. This helps to ensure that the webhook delivery is from {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)."
19+
> [!WARNING]
20+
> To avoid accidental exposure of sensitive information, do **not** include sensitive information in your payload URL.
21+
> This includes your own API keys and other authentication credentials. Instead, to validate that webhook deliveries were sent by {% data variables.product.github %} and have not been tampered with, use a webhook secret. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/validating-webhook-deliveries)."
2022
2123
The webhook secret should be a random string of text with high entropy. You should securely store your webhook secret in a way that your server can access.
2224

0 commit comments

Comments
 (0)