DocumentaciónHelp

Test the connection

Check that the platform reaches your system's API with the saved credentials.

On this page

Test queries your system's API with the address and credentials you saved, and tells you whether it responded and how long it took. Use it after creating an integration or changing its credentials.

Before you start

  • You need the Editor or Administrator role.

  • The integration must have a Base URL. If it doesn't, the button is disabled and says Set the base URL to test the connection.

Steps

  1. Go to Settings → Integrations.

  2. On the integration's card, press Test.

  3. Wait for the result: a notice appears at the top.

The Base URL followed by the Health path you defined is queried; if the path is empty, only the Base URL. The query is read-only and waits up to 10 seconds.

Results

Message

What it means

Connection successful. (with the HTTP code and the milliseconds)

The system responded correctly.

The system responded … (with a code, for example 401)

It reached the system, but the system rejected the query. A 401 or 403 usually means an incorrect credential; a 404, a Health path that doesn't exist.

No response within 10 s.

The system didn't respond in time. Check the Base URL and that the system is reachable from the internet.

Could not connect (with a network code)

The connection couldn't be opened: wrong address, system turned off, firewall or expired certificate.

The stored credentials can't be decrypted…

Type the credential again by editing the integration.

The base URL is not valid. or Only http or https URLs are allowed.

Correct the Base URL by editing the integration.

The server name could not be resolved.

The Base URL host name doesn't exist on the internet. Check that it is spelled correctly.

The URL points to a private network; this is not allowed from the platform.

The address is internal to your network. The platform only tests systems reachable from the internet.

What happens next

  • If the system responded (successfully or with an error code), the card updates Last sync. If the test succeeds, the status stays Active.

  • If the system responded with an error code, didn't respond in time or couldn't be connected to, the status changes to Error and the card shows the reason below the name. The status goes back to Active with the next successful test or when a new event arrives through the webhook.

  • If the Base URL isn't valid, doesn't exist or points to a private network, you only see the notice: the card's status and dates don't change.

Testing a Paused integration changes its status: it becomes Active if the test succeeds or Error if it fails, and in both cases the webhook accepts events again. If you want it to stay paused, pause it again after testing. See Edit, pause or delete an integration.

With OAuth 2.0 (client credentials), for now the test queries your system without authenticating. If your system requires authentication on that path, the test will respond with a code such as 401 even if the credentials are correct.

The test doesn't affect event reception: a system can send events through the webhook even if the platform can't reach its API.

Related

Search SofIA Governance

Type at least 2 characters to search SofIA Governance.

↑↓ to navigate · Enter to open · Esc to close