Skip to content

Integrations

"Integrations" connects StyxView with the tools your team already uses. The page has three tabs:

TabWhat you do there
IntegrationsSynchronise your email account list from Microsoft Entra ID, and send notifications to your IT service management (ITSM) product.
ConnectorsConnect third-party tools to automate alert workflows.
API KeysCreate and manage the keys that call the StyxView API.

In the left menu, go to "Configuration" → "Integrations". Only users with the Admin role see this page.

The "Integrations" tab, with "Sign In With Microsoft" for email account synchronization and the "ITSM" panel for notifications.

Active Directory - Email Account List Synchronization

Section titled “Active Directory - Email Account List Synchronization”

This panel connects your Microsoft Entra ID tenant, so StyxView can read the list of email accounts in your directory.

  1. Select "Sign In With Microsoft". You need Microsoft Entra administrator permissions.
  2. Sign in and grant the permissions Microsoft asks for.
  3. When you return to StyxView, the panel lists each connected tenant with its "Tenant ID", "Organization Domains", and "Last Sync Date".

If the account you signed in with is not an administrator, StyxView shows "AD sync failed - please try again with admin access".

This panel sends notifications to your ITSM product.

  1. In "Product", select your ITSM product: Jira, Freshworks, ServiceNow, or Manage Engine.
  2. For ServiceNow, enter the "Username", "Password", and "Subdomain" of your ServiceNow instance. The subdomain uses lowercase letters, numbers, and hyphens only. To change saved ServiceNow details, select the pencil icon.
  3. In "Notification Type", choose which severities send a notification:
    • Critical, High, Medium, Low
    • Critical, High, Medium
    • Critical, High
    • Critical
  4. In "Email Address", enter the address the notifications go to.
  5. Select "Save".

"Connectors" lists the third-party tools you have connected to automate alert workflows.

The "Connectors" tab of Integrations, with "Add Connector" and the tools connected to automate alert workflows.

  1. Select "Add Connector" and choose the tool.

    The "Add Connector" menu on the "Connectors" tab, listing the tools StyxView can connect to.

  2. In the "Configure" step, enter the "Unique Identifier Name", the "Base URL", and the credentials the tool asks for. If the tool offers more than one way to sign in, choose it in "Auth Type".

  3. Select "Test Connection" to check the details.

  4. Optional: in the next two steps, map how data moves from StyxView to the tool and from the tool to StyxView. Select "Skip" to leave a step out.

  5. Select "Save".

To change a connector, select its "Edit Connection" icon. To remove it, select its "Delete Connector" icon, then "Delete".

API keys let your own systems call the StyxView API. The API is documented in the API reference in this documentation.

The "API Keys" tab, with "Download Postman Collection", "Create API Key", and each key's tracking ID, name, dates, and scopes.

Select "Download Postman Collection" to download a Postman collection of the API.

  1. Select "Create API Key".

    The "Create API Key" dialog, with a name entered, "Third Party" expanded, and only "Third party summary" selected, shown as "1 of 4".

  2. In "Name", enter a name that says what the key is for, for example Reporting feed.

  3. Under "Scope", choose what the key can reach. Nothing is selected to begin with. Select a solution to give the key all of its endpoints, or select the arrow beside it and choose individual endpoints. The count beside each solution shows how many of its endpoints you have chosen, for example "1 of 4". See What each scope reaches.

  4. Select "Save". The "Save your key" dialog shows the key and its "Permissions", for example "Third Party: Third party summary".

  5. Select "Copy", store the key somewhere safe, and select "Done".

An account can have up to 5 API keys, in any combination of scopes, and two keys can have the same scope, for example one for each system that calls the API. When the account already has 5 keys, "Create API Key" shows "API key limit reached": delete a key you no longer use, or edit an existing key's scope.

Each solution's scope is made of the endpoints below. Give a key only the endpoints the system using it needs.

EndpointRequestCompany ProtectionExecutive ProtectionThird Party
ProjectsGET /v1/projectsYesYesYes
Risk dataGET /v1/dataYesYesYes
AlertsGET /v2/alertsYesYesYes
Third party summaryGET /v1/tp-summaryNoNoYes

A key without an endpoint in its scope gets 403 with the message API key not authorized for this endpoint! on that endpoint. A key that has an endpoint for some solutions only gets 403 with Project not accessible with this API key! when it asks for a project of another solution. For example, a key with only "Third party summary" reads the third party summary and nothing else.

The table lists the keys of the selected account:

ColumnDescription
Tracking IDThe identifier of the key. It changes when you re-roll the key.
NameThe name you gave the key.
CreatedWhen the key was created.
UpdatedWhen the key was last changed.
ScopesOne chip per solution the key can reach. A chip such as "Third Party · 1/4" means the key reaches only some of that solution's endpoints; hover over it to see which.

Each row has three actions:

  • Edit: change the name or the scope. The key itself does not change, and a new scope applies from the key's next request.
  • Re-roll: generate a new key in place of the current one. The current key stops working immediately, and the new one is shown once.
  • Delete: delete the key. Any system using it stops authenticating immediately.