grafana / oncall

Developer-friendly incident response with brilliant Slack integration
GNU Affero General Public License v3.0
3.48k stars 285 forks source link

Enhance documentation for INBOUND_EMAIL_WEBHOOK_SECRET in Inbound Email Setup #4573

Open Axel-sys-777 opened 3 months ago

Axel-sys-777 commented 3 months ago

What would you like to see!

Summary: The current documentation for configuring the Inbound Email integration in Grafana OnCall lacks clarity on how to obtain the INBOUND_EMAIL_WEBHOOK_SECRET. This can cause confusion for users who are not sure where to find this secret, especially for different Email Service Providers (ESPs).

Details: Please update the "Inbound Email Setup" section of the documentation with the following information:

  1. Clarification on INBOUND_EMAIL_WEBHOOK_SECRET:
    • Specify that the INBOUND_EMAIL_WEBHOOK_SECRET is provided by the ESP.
    • Provide an example for Mailgun, mentioning that the INBOUND_EMAIL_WEBHOOK_SECRET is the HTTP webhook signing key.

Product Area

API

Anything else to add?

No response

github-actions[bot] commented 3 months ago

The current version of Grafana OnCall, at the time this issue was opened, is v1.7.2. If your issue pertains to an older version of Grafana OnCall, please be sure to list it in the PR description. Thank you :smile:!