Web Integration

Web Integrations defines how Job Management (Connect) sends and receives data between external systems using web-based APIs. You can use Web Integrations to exchange information with third-party applications, integration platforms, supplier systems, finance systems, or services such as BARIS or Microsoft Dynamics.

A Web Integration controls how Job Management (Connect) formats requests, authenticates with external services, and handles communication failures or retries. Depending on the integration, you can configure request payloads, HTTP methods, authentication details, certificates, header, and retry behaviour.

You can typically use Web Integration:

  • integrating Job Management (Connect) with external business systems

  • sending outbound order or appointment information

  • importing or synchronising external data

  • connecting to middleware or message bus platforms

  • configuring BARIS or supplier integrations

  • managing secure API communication between systems

The configuration options available depend on the type of integration being created and the authentication method used.

Authentication and Security

Some integrations require additional security configuration depending on the external platform being used. This can inclue:

  • OAuth authentication

  • API keys

  • custom HTTP headers

  • client certificates

  • service account credentials

When certificate authentication is enabled, you must manage certificate validity and renewal to avoid connection failures.

Retry Behaviour

Retry settings help prevent temporary communication failures from interrupting integrations. If a request fails, Job Management (Connect) retries the request based on the configured Retry Count and Retry Interval values before marking the transaction as failed.

This can help reduce failures caused by:

  • temporary network interruptions

  • service outages

  • timeout issues

  • intermittent API availability problems

Configure Web Integration

  1. Navigate to Configuration > Integration > Web Integration.

  2. Complete the fields:

    • Retry Count: Enter the number of times Job Management (Connect) retries sending the message if the initial attempt fails. The maximum retry count is 5.

    • Retry Interval (Milliseconds): Enter the delay, in milliseconds, between retry attempts. For example, 5000 = 5 seconds.

    • Redirect URL: Enter the URL that the target system redirects to after processing the request. This is typically used for SSO or callback-based integrations. Leave this blank if the integration doesn't use redirects.

    • Authorisation Required: Select this option if the target system requires authentication before accepting requests.

      • Select an existing configuration in Authorisation Config Group. These are preconfigured authentication settings created in Configuration > Integration > Message Bus > Authorisation Config.

    • Custom Headers Required: Select this option if the target system requires additional HTTP headers.

      • Add the required Header Parameters as Key-Value pairs. For example, API version headers or subscription keys. Refer to the target system's API documentation for the required header values.

    • HTTP Method: Select the HTTP method used for the request. Common methods include POST, PATCH, or GET. Refer to the target system's API documentation or integration specification for the required method.

    • Content Type: Select the format of the request data sent to the target system. This must match the format expected by the target system. Common options include application/json, application/xml, and text/xml.

    • Target URL: Enter the full endpoint URL that requests are sent to. This is a typically the API or service endpoint provided by the target system administrator.

    • Request Template: Enter the request template that defines the data sent to the target system. The template is written in JSON or XML and can include Job Management (Connect) tokens to dynamically insert values, such as order or customer information. Use the format required by the target system.

    • Use Client Certificate: Select this option if the target system requires certificate-based authentication:

      • Current Client Certificate: Displays the currently attached certificate and its expiry date.

      • Add New Client Certificate: Select Choose File to upload a .pfx certificate file.

      • Certificate Passphrase: Enter the passphrase associated with the uploaded certificate file, if required.

    • Requestor: Enter the identifier used by the target system to recognised the source of the request. This value is proved by the target system administrator. Don't include spaces or special characters.

    • Username: Enter the username used to authenticate with the target system. This value is provided by the target system administrator.

    • Password: Enter the password associated with the Username. Together with the Requestor and Username, this forms the credentials that identify and authenticate Job Management (Connect) to the target system.

  3. Select Save.

Follow-up Tasks

After creating a Web Integration, you might also need to:

  • configure integration traffic monitoring

  • create export or import mappings

  • configure message templates

  • map contracts or order types

  • configure supplier or subcontractor integrations

  • test authentication and endpoint connectivity