Сonnection
For identification of demands from third party systems in Alert Catcher, there is created the additional entity - connection. In essence, the connection is the name of the system from which you will receive notifications. When you create a connection, a REST-resource is created as well, so that you can use to create/change incidents in Jira.
Read more about the REST resource for incident creation and its benefits here.
View all connections
To view all connections, go to Connections page.
To create a connection, click on the button Create connection.
Connection creation
On the connection creation page you need to specify:
- Name of connection
- Description (field not required)
- Endpoint name - is required to form a REST resource (see Creating incidents )
- Project (meaning which project will create the incidents)
- Issue type in the project (for which type of issues incidents will be created)
- Default reporter - the user whose account will be used to create incidents, perform post-functions and create problems.
Once the connections are established, you will be directed to the rule management screen.
Activation of connection
Once the connection is established, you need to put it in the active state. To do this, go to the Connection settings tab and change the value of the State field.
Connection settings
To change the connection, click the Connection settings tab. This page shows you the basic connection settings as well as the REST resource for creating incidents. This screen displays the same fields that you used to create the connection. The last field, State, is responsible for the connection activity. If the connection is in Disabled state, you cannot create new incidents.
Connection security
The Security tab displays additional information to configure the connection.
The following fields are available on the settings page:
- Anonymous requests (Enabled/Disabled) determines whether to specify additional information in the request header (Token API)
- Creating incidents via GET requests - allows you to create incidents in Jira with a get-request (more details on the this page).
- Allowed IP - filtering requests by a specific IP address. If you specify the IP address from which requests are received, all requests from other addresses will be ignored.
- API Token - the key that you add to the request header instead of using Bearer auth.