For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mutual TLS

Saleschat Mutual TLS allows organizations to configure an additional layer of security for their Saleschat API traffic. Once configured, API requests should be made to https://mtls.apis.saleschat.pro (or https://mtls.apis.t.saleschat.pro for UAT environment) and traffic will only be accepted if the right API key and client certificate are provided. mTLS does not apply to the normal TLS domain, https://apis.saleschat.pro or https://apis.t.saleschat.pro.

Customer-Owned Certificate Model

Saleschat uses a Bring Your Own Certificate (BYOC) Model.

In this model -

  • Enterprise generates and owns the private key.

  • Enterprise generates the client certificate.

  • Enterprise shares only the public certificate with Saleschat.

  • Saleschat registers and trusts the certificate.

  • Enterprise uses the private key locally to establish mTLS connections.

Certificate Requirements

Setting
Recommended Value

Key Type

RSA

Key Size

2048 or 4096

Signature Algorithm

SHA256

Validity

1 year

How to generate the certificate?

Run this command on a secure machine/server.

Generated file will be -

This is a sensitive file. Store it securely, do not share it with Saleschat or anyone outside your organization.

Set the permission for the file -

Run the following to generate the client certificate -

Subject is optional, and you can replace ${YOUR_COMPANY} with your company name in format. This has got nothing to do with the client or server domain.

Generated file will be -

How do I setup mTLS integration?

On the settings page, you'll see 'mTLS' tab on the left navigation bar

Click on the 'Upload Certificate' button.

You can either upload the X.509 public certificate file, or copy and paste the contents of the file. Click on upload and the certificate would be applicable. You can then use the https://mtls.apis.saleschat.pro (or UAT) domain to make API requests.

How to test if the certificate is working?

Use the following CURL to verify if you've configured the certificate correctly

You should 200 OK response with the following text -

Last updated