English – Page 13

Validation of the mobile number is needed to enable various functions
on the platform, such as integrating notifications via WhatsApp and the
full functioning of Call Rotation, a feature for on-call and alternate
team schedules. Therefore, each user must individually validate their
mobile number on the platform.

To perform this validation, follow these steps:

Click on “Account” in the side menu of the platform. You will be directed to the page with your registration details.
Fill in your name and your phone number in the designated fields.
Click on the “Send verification code” button to receive the verification code via SMS.
The registered mobile number must be the same one used for WhatsApp,
phone calls, and SMS. Make sure to use the correct mobile number for
validation.

A message box will appear on the platform page requesting the
four-digit verification code. If you don’t receive it, you can request
the verification code to be resent through the same message box.

Once you receive the SMS on your mobile phone, enter the four-digit code you received in the message box.

After completing all the steps, the information “Verified phone
number” in green will be displayed in your registration data to
symbolize that the validation was successful. Then click on “Save” to
finalize it. Afterward, you, as a platform user, will be able to make
full use of the notification and Call Rotation functionalities.

Expanding more and more notification channels to improve the
efficiency of your development team for incident alerts, you can also
enable notifications via WhatsApp.

Before starting the team configuration, it is necessary for the
registered users in the team to have their mobile numbers validated on
the platform. Otherwise, you won’t receive the notification. To validate
the mobile number, click here.

To set up WhatsApp as a notification channel, click on “Teams” in the
platform’s side menu and select the team that will receive the alerts.
If you want to create a new team, click on the “New” button in the top
right corner of the screen and follow the steps.

When you access the settings of the selected team, click on the
“Notifications” tab in the top bar and enable the option “Send a
notification to WhatsApp.” After enabling this function, you can select
which team members will be notified and then click on “Save” to finish
the setup.

Notifications are sent only to
individual contacts, and there is no option to send notifications to
groups. Please note that only users who have their mobile numbers
validated can receive alerts.

In the “Teams” section of the platform, there are options for
communication channels that receive related notifications, which may
vary from time to time. Considering this, the platform offers
notifications via Telegram, for either private chats or groups.

To configure Telegram notifications, follow these steps:

Click on “Teams” in the platform menu.
If you want to create a new team, click on the “New” button in the top right corner of the screen and follow the steps.
For existing teams, access the desired team and click on the “Notifications” tab in the top bar.
Check the checkbox next to the option with the Telegram icon.
Enter the ID of the private chat or group you wish to notify in the provided field.
Click “Save” to finalize the setup.

Each team can have only one Telegram ID for notifications; however,
the same ID can be used in other teams to centralize notifications,
according to their internal team needs.

How to find the Telegram ID

In a private chat:

Access the Telegram app on your smartphone, search for “GlorfindelBot” in the search field.

Select the option with the name “1P,” featuring the platform’s logo,
and then start a chat. Type the command: /mychatid, and you will receive
the chat_id in response, which will help you identify the chat where
you wish to receive notifications.

Example: The chat_id is: XYZQKHRT

So, XYZQKHRT is the chat_id, a code that the platform can use to identify the chat where you want to receive notifications.

In a group:

To create or use in an existing group, access the Telegram app on your
smartphone, search for “GlorfindelBot,” and add it to the desired group.

After adding it to the group, type the command: /mychatid, and you
will receive the chat_id in response. It is with this code that the
platform can identify where you want to receive notifications.

Example: the chat_id is: -XYZQKHRT

-XYZQKHRT is the chat_id, and it is with this code that the platform can identify where you want to receive notifications.

The chat_id of the group starts with a hyphen, and you must not forget to include it when adding it to the platform.

In the “Teams” section of the platform, there are options for
communication channels to receive related notifications, which may vary
from time to time. Considering this, the platform provides notifications
via Slack for both private chats and groups.

To set up notifications via Slack, follow these steps:

Click on “Teams” in the platform’s menu.
If you want to create a new team, click the “New” button in the top right corner of the screen and follow the setup process.
For already registered teams, access the desired team and click on the “Notifications” tab in the top bar.
Check the checkbox for the option that has the Slack icon.
Click on “install our Slack App first” to initiate the setup process for Slack notifications.

A window will open with some Slack settings. In the top right corner,
you can select which workspace you want to notify. Next, you can see
which actions will be allowed, and finally, you can choose the channel
or private chat to which you want to send the notifications.

Click on “Allow,” and it will be automatically configured on the platform with the name of the selected workspace and channel.

After configuring, simply click on “Save” at the end of the options.
When the first incident occurs, the notification will be sent via Slack.

Through the notification received via Slack, you will be able to give Resolve and Acknowledge.

Note:
The “Resolve” button only works on incidents generated by external
integration or manual incident, as these can be resolved manually.
Incidents generated by monitoring are only resolved automatically.

To proceed with the configuration, you must have Google Chat enabled in
your Google account. To activate Google Chat, it’s simple, just access
the link provided,
and it will be done automatically. If you encounter any issues, please
check the support link on how to enable it in your account. Click here to contact Google support for Google Chat.

Configuring the bot in chats or private groups:

Enter Google Chat and, in the left sidebar, find the chat where you want to create the bot.
Click on the arrow next to the chat name and then click on “Manage webhooks.”

A message box will open. In it, enter the name that will be given to
the webhook and, if you have it, a URL with the image that will be used
as the bot’s avatar. Then, click on “Save.”

Once you fill in the fields, the message box will update, and the
connector will be ready for use. To copy the URL, click on the icon with
two papers next to the address. This URL is used to enable you to
receive incident notifications in your team on the platform. To learn
how to do this, simply click here.

In the “Teams” section of the platform, we have options for channels
to receive incident notifications through different internal and
external communication platforms. With that in mind, we have also
developed notifications via Google Chat, for private or group chats.

To configure notifications via Google Chat, click on “Teams” in the
side menu of the platform. If you want to create a new team, click on
the “New” button in the upper right corner of the screen and follow the steps. For teams already registered, access the desired team and click on the “Notifications” tab in the top bar.

After accessing the “Notifications” tab, check the checkbox next to
the option that has the Google Chat icon. Then, add the webhook link
provided when creating the bot in the box next to it. After that, click
on “Save,” and the incident notifications via Google Chat will be
configured.

For more detailed information on how to set up the bot in Google Chat, you can click here.

The Elven Works platform integrates with all the most popular
internal communication tools in the market, such as Slack, Telegram,
Google Chat, SMS, WhatsApp, and Discord.

To configure Discord notifications, you can set them up for any channel on a server. Follow the instructions below to set it up:

Click on “Teams” in the side menu. If you want to create a new team,
click on the “New” button in the top right corner of the screen and
follow the steps.
For teams that are already registered, access the desired team and click on the “Notifications” tab in the top bar.
Check the checkbox next to the option with the Discord icon, and then click on “Integration instructions.”

A message box will pop-up with the instructions that need to be executed in the Discord application.

With the Discord application open and logged in, select the server
where you want to receive notifications in case of incidents.
Right-click on the server’s icon, go to “Server Settings,” and then
click on “Integrations.”

Click on “Webhooks” and create a new webhook to use in the
integration. Configure your webhook with an image, a name, and select
the channel where you want to receive notifications. Copy the webhook
URL and go back to the platform page you were configuring. Paste the
webhook URL in the “Webhook URL” field.

After copying and pasting the URL, click on “Save” to finish the configuration.

Observation:

The discord API has a limit of 30 messages per minute according to the documentation.

To add a dependency, go to the application screen, scroll down to “External Dependences“

Here you can add in 2 ways:

1 – Creating a new monitoring as a dependency of this application, clicking on the “+” and configuring it.

2 – Searching for an existing application to be a dependency of the current application, using the search field.

Note: The application will only appear in the list if it is of
the internal monitoring type (through the agent installed in your
environment)

Below is an example of a script for simple monitoring, where you can
press 1 or 2 to send “OK” or “Failure” via webhook. The purpose of this
example is to demonstrate how the calls should be made for monitoring
using the webhook created by the platform.

The script collects data from your application or dependency,
interprets the results, and delivers them to the platform according to
the instructions of “Hits and Failures” presented in the box on your
application’s page registered on the platform.

Example:

				
					#!/bin/bash

echo "Failure ou OK?"
echo "1. Failure"
echo "2. OK"
read status
echo "-------------"

token=`curl --request POST \
--url https://apis.elven.works/external/auth/v1/client/<Your Company URL> \
--header 'Content-Type: application/json' \
--data '{
"client_id": "<YOUR INFORMATION HERE>",
"client_secret": "<YOUR INFORMATION HERE>" }' | sed 's/{"access_token":"//g' | sed 's/","expires_in":300,"token_type":"Bearer"}//g'`


if [ $status == 2 ]; then
echo "OK"
curl -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $token " https://apis.elven.works/external/monitoring/v1/hits --data '{"latency": 100000, "service": <YOUR SERVICE ID HERE>, "organization": "<YOUR ORGANIZATION ID HERE>"}'
fi

if [ $status == 1 ]; then
echo "Failure"
curl -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $token " https://apis.elven.works/external/monitoring/v1/failures --data '{"issue": "<Your message>", "service": <YOUR SERVICE ID HERE>,"organization": "<YOUR ORGANIZATION ID HERE>"}'
fi

Suitable for Python 3 or higher, the example below is a script for simple monitoring, pressing 1 or 2 to send OK or Failure.

The purpose of this example is just to demonstrate how calls should be made for monitoring, via webhook, created by the platform.

Example:

				
					import requests

print('FAILURE OR OK?')

print('TYPE 1 FOR FAILURE')

print('TYPE 2 FOR OK')



status = int(input('SELECT 1 OR 2:'))



choice = status



print('---', 'the option to be performed is: ', choice, '---')



token_headers = {'Content-Type': 'application/json'}



token_url = 'https://apis.elven.works/external/auth/v1/client/<Your Company ID>'



token_payload = {

'client_id': '<YOUR INFORMATION HERE>',

'client_secret': '<YOUR INFORMATION HERE>'

}



req_token = requests.post(

url=token_url,

json=token_payload,

headers=token_headers

)



token = req_token.json()['access_token']



req_headers = {'Content-Type': 'application/json',

'Authorization': 'Bearer ' + token}



req_url = 'https://apis.elven.works/external/auth/v1/client/<Your Company ID>'



req_payload = {'service': <YOUR SERVICE ID HERE> ,

'organization': '<YOUR ORGANIZATION ID HERE>'}



if (status == 2):

print("HITS")

hits_latency = {'latency': 100000}

req_payload.update(hits_latency)

hits = requests.post(

url=req_url + 'hits',

json=req_payload,

headers=req_headers

)

print(req_payload)

print(hits.json())



if (status == 1):

print("failures")

failures_issue = {'issue': 'Error message'}

req_payload.update(failures_issue)

hits = requests.post(

url=req_url + 'failures',

json=req_payload,

headers=req_headers

)

print(req_payload)

print(hits.json())