Environment Variables

Channel variables

Here you can find the list of all variables that can be used for the channels. The type of the variable is always indicated. We try to provide a small explanation for each point here and possibly refer to the documentation.

Gotify

Both the base url and the key must be specified here. More information can be found here in the official documentation.

Channel	Environment Variable	Example	Type	Is required
Gotify	GOTIFY_BASE_URL	https://gotify.ech...	string	true
Gotify	GOTIFY_KEY	aefvtestw	string	true

Pushover

You can find the two keys in your pushover account. You can find more information about where to find them here.

Channel	Environment Variable	Example	Type	Is required
Pushover	PUSHOVER_TOKEN	fsafuehdfsaio4a2s2...	string	true
Pushover	PUSHOVER_USER	iow781dfewsa7efler...	string	true

Matrix

In order to connect your Matrix server correctly, some data is required. You can find the corresponding documentation here.

Channel	Environment Variable	Example	Type	Is required
Matrix	MATRIX_BASE_URL	https://matrix.org...	string	true
Matrix	MATRIX_ROOM_ID	!tROmvinGWdwffIDew...	string	true
Matrix	MATRIX_ACCESS_TOKEN	syt_cm9fewb3Q_b21...	string	true

Telegram

For telegram you need the token of the bot and the chat id. Please add the token in front of your received token "bot". You can find the documentation here.

To find the correct chat id, you can call this address with your telegram api token. Here you can find all updates for your bot: https://api.telegram.org/bot<telegramApiToken>/getUpdates.

Channel	Environment Variable	Example	Type	Is required
Telegram	TELEGRAM_API_TOKEN	bot510484:AAHzdOLo...	string	true
Telegram	TELEGRAM_CHAT_ID	-807198751	string	true

Discord

Here you only have to enter the discord webhook url. How to get it, you can find here. You can also customize the bot name. If you don't want this, "echGo" will be set automatically.

Channel	Environment Variable	Example	Type	Is required
Discord	DISCORD_WEBHOOK_URL	https://discord.com...	string	true
Discord	DISCORD_BOT_NAME	echGo	string	false

Slack

In order to send a message in Slack, you need a webhook url. You can find out how to get it here.

Channel	Environment Variable	Example	Type	Is required
Slack	SLACK_WEBHOOK_URL	https://hooks.slack...	string	true

Trello

Here you can find instructions on how to get trello keys and tokens.

If you want to find the id list, you can open the board in and write .json behind the url. Now look for the field idList, then you have found the id.

Channel	Environment Variable	Example	Type	Is required
Trello	TRELLO_KEY	b4d21261bc8cf6c409f...	string	true
Trello	TRELLO_TOKEN	b2382okl3efd7d43080...	string	true
Trello	TRELLO_ID_LIST	87467w8afd2b8db569d...	string	true

Zendesk

Here you can find the quick start documentation of zendesk.

Channel	Environment Variable	Example	Type	Is required
Zendesk	ZENDESK_BASE_URL	https://echgo.zende...	string	true
Zendesk	ZENDESK_USERNAME	b4d21261bc8cf6c409f...	string	true
Zendesk	ZENDESK_API_TOKEN	a23dfvsebc8cf6c409f...	string	true

osTicket

Here you can find the documentation.

Channel	Environment Variable	Example	Type	Is required
osTicket	OS_TICKET_BASE_URL	https://osticket.ec...	string	true
osTicket	OS_TICKET_API_TOKEN	aerds78FeRtsDfu2ldf...	string	true
osTicket	OS_TICKET_USERNAME	echGo	string	true
osTicket	OS_TICKET_EMAIL_RECIPIENT	mail@echgo.org	string	true

Twillo

Here you can find the documentation, the information like account sid, auth token and phone number can be found in your account.

Channel	Environment Variable	Example	Type	Is required
Twillo	TWILLO_ACCOUNT_SID	AC5f2uf324e060e6de4...	string	true
Twillo	TWILLO_AUTH_TOKEN	3eb4c17237b85e36ca9...	string	true
Twillo	TWILLO_PHONE_NUMBER	+15017122661	string	true
Twillo	TWILLO_MY_PHONE_NUMBER	+15558675310	string	true

SMTP

Here you only have to enter your smtp access data and an email address to which you want to send the email.

Channel	Environment Variable	Example	Type	Is required
SMTP	SMTP_HOST	smtp.echgo.org	string	true
SMTP	SMTP_PORT	465	integer	true
SMTP	SMTP_USERNAME	mail@echgo.org	string	true
SMTP	SMTP_PASSWORD	Test123	string	true
SMTP	SMTP_EMAIL_RECIPIENT	mail@gowizzard.de	string	true

Webhook

With the webhook you only have to enter the url where you want to send the post request.

Channel	Environment Variable	Example	Type	Is required
Webhook	WEBHOOK_DOMAIN	https://echgo.org/w...	string	true

The required only refers to when you want to use this channel, otherwise the values do not need to be filled in.