Skip to content

Commit

Permalink
[Docs] add details inbound email integration setup (#3198)
Browse files Browse the repository at this point in the history
# What this PR does

This PR adds some more depth to the documentation regarding the setup of
the "Inbound Email" integration.
In particular it references the setup requirement in the integration
documentation and also outlines the requirements for the secret syntax
and usage in the process.

## Which issue(s) this PR fixes

#3015

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
  • Loading branch information
N3X14 authored Nov 21, 2023
1 parent 0000251 commit 92ed226
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/sources/integrations/inbound-email/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ weight: 500

Inbound Email integration will consume emails from dedicated email address and make alert groups from them.

## Configure required environment variables

See [Inbound Email Setup]({{< relref "../../open-source/_index.md#inbound-email-setup" >}}) for details.

## Configure Inbound Email integration for Grafana OnCall

You must have an Admin role to create integrations in Grafana OnCall.
Expand Down
4 changes: 3 additions & 1 deletion docs/sources/open-source/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,9 @@ To configure Inbound Email integration for Grafana OnCall OSS populate env varia
- `INBOUND_EMAIL_DOMAIN` - Inbound email domain
- `INBOUND_EMAIL_WEBHOOK_SECRET` - Inbound email webhook secret

You will also need to configure your ESP to forward messages to the following URL: `<ONCALL_ENGINE_PUBLIC_URL>/integrations/v1/inbound_email_webhook`.
Required secret syntax: `part1ofsecret:part2ofsecret` (The colon `:` is a mandatory delimiter separating both parts of your secret.)

You will also need to configure your ESP to forward messages to the following URL: `scheme://<INBOUND_EMAIL_WEBHOOK_SECRET>@<ONCALL_ENGINE_PUBLIC_URL>/integrations/v1/inbound_email_webhook`.

## Limits

Expand Down

0 comments on commit 92ed226

Please sign in to comment.