Chat/Messaging - Freshchat
Capacity integrates with Freshchat live chat and messaging platform, using a combination of an inbound webhook and outbound API calls to retrieve chat participant data. This integration requires coordination between the your Freshchat admin and Capacity Engineering.
How It Works
There are two data flows:
- Messages and events (inbound): You configure a webhook in Freshchat that sends message and event data to a Capacity-provided endpoint.
- Chat participant data (outbound): Capacity calls the Freshchat API to retrieve additional participant/conversation data using the credentials below.
Configuration Steps
Locate your App ID
- Log in to your Freshchat account and select Admin from the left-hand menu.
- Select Account Settings.
- Under Agent Messenger, locate the App ID and select Copy.
Generate an API Key
- From the Admin page, select API Tokens.
- Select Generate Token. Freshchat creates the token automatically.
- Select Copy to copy the token.
Configure the webhook and retrieve the RSA Public Key
- From the Admin Settings page, select Marketplace and Integrations >> API >> Conversation Webhooks.
- Toggle the Webhook status to Enabled
- In the Webhook field, enter the Capacity-provided endpoint URL.
- In Failure Notifications, enter the email address that should receive webhook failure alerts.
- Under Authentication, select Copy next to the auto-generated RSA public key.
- Select Save.
What Capacity Shares
Capacity will provide you with an API endpoint to configure within your Freshchat instance. e.g. [CUSTOMER NAME].audio.tethr.com
What to Share with Capacity
| Item | DescriptionApp ID |
|---|---|
| App ID | The App ID obtained from your Freshchat instance |
| API Token | The API Token generated above |
| RSA Public Key | The RSA public key generated above |
| Subdomain | Account URL for your Freshworks instance. For example: [YOUR COMPANY].freshchat.com |
Once received, Capacity will test the webhook and API connection and confirm successful data flow with you before this integration goes live.
