Skip to content
English
  • There are no suggestions because the search field is empty.

Managing your Connector Settings

A step-by-step guide on connecting to CyberHQ Connect

Your connector settings are the gate through which automated external data enters your workspace. Found at Settings > Connectors, this page is the CyberHQ side of your integration with CyberHQ Connect. It holds the credentials that authorise the two platforms to talk to each other, and it determines what Connect can see and where incoming data is allowed to land. Understanding this page helps you keep your automated data flowing and troubleshoot it if the link is ever interrupted. This article gives you an overview of what the page does; the step-by-step for first-time setup lives in a dedicated how-to.

Connect Organization ID

The Connect Organization ID field identifies which Connect organisation your workspace is paired with. You copy this identifier from your organisation in Connect and paste it here, so CyberHQ knows which Connect environment to trust. Without a matching Organization ID, the two platforms cannot recognise each other and no data can flow.

Connector Token

The Connector Token is the private key that authorises the connection. You generate it in Connect's Token Manager and paste it into this field, then click Save to complete the link. Because the token grants access, treat it like a password. It is shown only once when created, so if it is lost or you need to rotate it, you generate a new token in Connect and re-save it here.

[NOTE: Keep your Connector Token secure. If the connection ever stops working because a token was lost or revoked, create a new token in Connect and paste it back into this page to restore the link.]

What linking enables

Once your Organization ID and token are saved, the Connectors page is what makes two things possible across the platforms:

First, any externally available templates you build in Connect become visible within your Templates settings in CyberHQ, ready to use. Second, the data models (schemas) of your CyberHQ modules are shared with Connect, where they appear as Models marked with a 'C'. This shared understanding of your modules is what allows a connector to map incoming data, such as issues from Jira or vulnerabilities from a scanner, into the correct place in your workspace automatically.

The Connectors page tabs

Settings > Connectors has three tabs, and opens on Manage:

  • Settings: the Connect Organization ID and Connector Token described above, and the Save button that links your workspace to Connect.
  • Templates: the templates your Connect organisation has made externally available, once the link is in place. Use Search by template name to find one.
  • Manage: the connectors set up in this workspace, and the Add button for creating a new one.

To use a template, open it from the Templates tab, choose the module to import the data into, complete any fields the template needs for authorisation, and save it. A connector is created on the Manage tab and linked to its Connect automation for you, so there's no webhook or token to copy.

The Manage tab

The Manage tab lists every connector in the workspace by name, with the module it feeds shown beside the name. Use the search box to find one. Click a connector's pencil icon to open its Edit Connector page. The webhook address and access token your Connect automation posts to are in the two boxes at the top right, each with a copy button. Currently Processing shows an import while it runs, and an import that couldn't be processed is marked as failed. Logs records when the connector was created and when data was imported, and by whom. Click Update to save changes to its name, description, module or logo.

Adding a connector

If you start from a template, the connector is created for you. To send data into CyberHQ from an automation you have built yourself in Connect, add a connector. It gives the automation an address to post to, and decides which module the data lands in.

  1. Go to Settings > Connectors and, on the Manage tab, click Add in the top right corner.
  2. On the Add Connector page, enter a Name. This is required.
  3. Optionally, add a Description of what the connector brings in and from where. The description box is a rich text editor, so you can format text, add lists and links, and embed images.
  4. Choose the Module the connector feeds. This is required, and it is the CyberHQ module the incoming data is imported into: Activity, Business System, Entity, Entity External Source, Issue, Maturity Assessment, Notification / Task, Program, Resource, Risk, Threat Scenario or User.
  5. Optionally, upload a Logo (JPEG or PNG, up to 20 MB) so the connector is easy to recognise in the list.
  6. Click Save to create the connector. It appears on the Manage tab.
  7. Open the new connector with its pencil icon on the Manage tab, and copy the webhook address and access token from the two boxes at the top right of its Edit Connector page. In Connect, add an HTTP node as the last step of your automation, set it to POST, and paste the webhook address into the target URL and the access token into the AUTHORIZATION header. Each time the automation runs, its data is imported into the connector's module.

Your connector settings are where the CyberHQ end of the integration is established and maintained. To set the link up for the first time, follow How to Link CyberHQ Connect to CyberHQ. For a broader understanding of how automated data ingestion works, see the CyberHQ Connect Overview. With this page configured, your workspace can receive live data from your external tools and keep your assessments, risk scores, and reports continuously up to date.