Freshsales (Freshworks CRM) connector

Your Silux Chat bot verifies customers against Freshsales (Freshworks CRM), then answers questions about their customer records from your live data.

API key Documented-API tested 1 capability Read-only

Start free Set-up guide Freshsales (Freshworks CRM) API docs

What your bot can do with Freshsales (Freshworks CRM)

Recognise and verify customers

Finds the customer in Freshsales (Freshworks CRM) by the email address or mobile number they give, checks their name and one more detail, then sends a one-time code to the contact details Freshsales (Freshworks CRM) holds. Nothing personal is shared until the code is entered.

Customers ask: “I want to check my account — it’s Jane Smith, jane@example.com”

Record IDNameEmail addressPhone / mobilePostcode

Set it up

Most businesses finish in under ten minutes. You need to be able to sign in to Freshsales (Freshworks CRM) as an administrator to create the key.

Step 1 — in Freshsales (Freshworks CRM)

1Freshsales
2profile picture
3Settings
4API Settings
5copy your API key; the domain is the part before .myfreshworks.com.

Least access: grant only the read permissions named above (customers, orders, invoices, bookings or tickets — whichever this connector uses). Never use an owner or full-admin key where Freshsales (Freshworks CRM) lets you create a restricted one.

Step 2 — in Silux Chat

1Open Dashboard → Integrations → Connectors and search for “Freshsales (Freshworks CRM)”.
2
Fill in:
Field Example Stored
Freshsales domain yourcompany Setting
API key •••••••• Encrypted
3Press Connect & test. The platform makes a real, read-only call to Freshsales (Freshworks CRM) with a made-up customer and shows a tick or a cross for each capability, with Freshsales (Freshworks CRM)’s exact error if something is refused.
4If this is your first way of verifying customers it is switched on automatically; otherwise press Use to verify customers. The platform then runs its chained test (verify → code → account → orders → invoices) with the built-in test customer — no real person is contacted.

Field	Example	Stored
Freshsales domain	yourcompany	Setting
API key	••••••••	Encrypted

You create an API key in Freshsales (Freshworks CRM) and paste it into your dashboard. It is sent in a request header on every call, over HTTPS only.

How customer verification works

STEP 1
Customer asks
They ask about their own account. The bot asks for their full name and their email or mobile, plus one more detail such as their postcode.
STEP 2
Found in Freshsales (Freshworks CRM)
The customer is looked up in Freshsales (Freshworks CRM) by email, then mobile. The surname must match exactly and the first name must match or start with the same letter, plus one more detail.
STEP 3
Code sent
A 6-digit code goes to the mobile Freshsales (Freshworks CRM) holds (by text, when your plan has SMS) or otherwise to the email it holds. The chat never chooses where it goes.
STEP 4
Verified
The customer types the code. It is valid for 10 minutes and five wrong attempts cancel it. The verified session lasts 30 minutes.

If the details don’t match, the customer is told only that they couldn’t be matched — never which detail was wrong. If Freshsales (Freshworks CRM) can’t be reached, the bot says it can’t check accounts right now rather than “no account found”. The bot is blocked in code from reading orders, invoices or bookings until verification succeeds. Full details: Customer identity verification & OTP.

What the bot can and cannot see

Can see (after verification)

Record ID
Name
Email address
Phone / mobile
Postcode

Only these standard fields are mapped from Freshsales (Freshworks CRM)’s responses. Everything else in the response is discarded before the bot sees it.

Never sees

passwords, security answers or login details
records belonging to anyone other than the verified customer
anything outside the fields listed alongside

Security

Keys encrypted at rest
Credentials are stored encrypted, shown only masked after saving, and destroyed — not just hidden — when you disconnect.
Read-only look-ups
Every capability is a look-up. The connector cannot create, change or delete anything in Freshsales (Freshworks CRM).
HTTPS only
Calls go to the vendor’s HTTPS address, redirects are not followed, and private network addresses are refused.
Injection-safe
Values a customer types are cleaned before they are placed in Freshsales (Freshworks CRM)’s search, and URL-encoded in addresses.
Other customers filtered out
A row that names a different customer’s email is dropped, whatever the vendor’s search returned.
Checked daily
Connections are re-tested every day, and the owner is emailed if a working connection starts failing.

More: Security & data protection.

Technical details

For developers and IT teams: the Freshsales (Freshworks CRM) endpoints this connector reads, relative to https://{domain}.myfreshworks.com/crm/sales/api. Values in braces come from the settings you enter.

Capability	Request	Standard fields returned
Recognise and verify customers	GET`/lookup`	id, name, email, phone, postcode

Test level: Documented-API tested. Each capability is run automatically against Freshsales (Freshworks CRM)’s documented example responses and must produce the standard fields; your own connection is then tested with a real call when you connect. The bot receives these through the standard Account Connect endpoints, exactly as if you had built them yourself.

Troubleshooting

What you see	Likely cause and fix
“the vendor refused the credentials (401)” or (403)	The key was revoked, has expired or was copied incompletely, or it lacks a read permission this connector needs. Create a fresh read-only key in Freshsales (Freshworks CRM) and reconnect.
“That Freshsales domain doesn’t look right”	Enter it in the form shown, e.g. yourcompany — without https:// or a trailing slash.
Customers are “not matched” although they exist	Customers are looked up by email or mobile, not postcode. Check the customer’s email or mobile is saved on their Freshsales (Freshworks CRM) record, and that the surname matches.
A capability shows a cross but others work	That permission wasn’t granted in Freshsales (Freshworks CRM), or your Freshsales (Freshworks CRM) plan doesn’t include that part of the API. Grant it and press Test.
“the vendor kept rate-limiting the request”	Freshsales (Freshworks CRM) returned “too many requests” three times in a row. The platform already waits and retries automatically (up to 10 seconds, as Freshsales (Freshworks CRM) asks); if it persists, ask Freshsales (Freshworks CRM) about your API quota.
Results are empty for a verified customer	The records exist under a different email or customer record in Freshsales (Freshworks CRM), or none are recent. Check the customer’s record in Freshsales (Freshworks CRM) directly.

Full error reference: Troubleshooting & error reference.

Frequently asked questions

Is the Freshsales (Freshworks CRM) connection read-only?

Yes. Every request Silux Chat makes to Freshsales (Freshworks CRM) is a look-up; none creates, changes or deletes anything in Freshsales (Freshworks CRM). Give the key or sign-in read-only permissions wherever Freshsales (Freshworks CRM) offers them.

Do I need a developer to connect Freshsales (Freshworks CRM)?

No. You paste the details listed in the set-up steps in Dashboard → Integrations → Connectors and press “Connect & test”. The platform makes a real call to Freshsales (Freshworks CRM) straight away and shows exactly which features work.

How does the bot know it is really my customer?

It finds the customer in Freshsales (Freshworks CRM) by the email or mobile they give, checks their name and one more detail, then sends a one-time code to the mobile or email held in Freshsales (Freshworks CRM) — never to one typed in the chat. The code lasts 10 minutes, five wrong attempts cancel it, and a verified session lasts 30 minutes.

What happens if my Freshsales (Freshworks CRM) key is revoked or expires?

The bot tells customers it can’t check their account right now — it never pretends there are “no orders”. Connections are re-tested daily and the account owner is emailed when a working connection starts failing. Reconnect it in Dashboard → Integrations → Connectors.

How has the Freshsales (Freshworks CRM) connector been tested?

It is Documented-API tested: every capability is run automatically against Freshsales (Freshworks CRM)’s documented example responses and must produce the standard fields. When you connect, it is tested again with a real call to your own Freshsales (Freshworks CRM) account before your bot uses it.