This section is for people who integrate SupportFast with other systems: developers, web agencies, IT consultants.
#The widget and its JavaScript API
The widget is the website chat. Besides the code to paste, it offers whoever develops the website:
- the JavaScript API, to open the chat from your own button, force the language, move the button with CSS and configure the website's Content Security Policy;
- user data, to pass the name, email and variables of customers signed in to the website to the chat;
- events, to count chat openings in Google Analytics and react from your own code.
Who uses it: whoever develops or maintains the website. Where: the code is in Chat agentAgent profileShare.
Read Widget JavaScript API and Passing user data.
#The webhook that starts an automation
An automation can start from an HTTP request. Your software sends a POST with a JSON body to a unique address, and the automation starts with that data. For example: a new order in your e-commerce store, a submitted form, an appointment in your management software. With the Webhook Response node, the automation can also reply to the caller.
Who uses it: whoever connects management software, e-commerce or integration tools. Where: in the automation's trigger, with the Webhook (API) source.
Read Starting an automation via webhook.
#The API node
The API node calls an external service from a flow, to read or write data in your management software, CRM or database. It makes GET, POST, PUT and DELETE requests, with parameters, headers and a JSON body, and the response can be used in the following nodes. It's available in automations and in the chat agent's Playground, inside a tool's chain.
Who uses it: whoever knows the API of the software to connect. Where: in the Playground of the automation or of the chat agent.
Read Calling an external API.
#The end-of-call webhook
At the end of a call, the voice agent can send a JSON with the call data and the extracted data to an address of yours. If you want, it adds the recording link. Each delivery is signed with a secret key, so your server can verify that it comes from SupportFast.
Who uses it: whoever wants the calls in their own CRM or management software. Where: in the voice agent, in Agent profileEdit ProfilePost-call, Webhook panel.
Read End-of-call webhook.
#The SIP connection
If you already have a PBX or a VoIP phone carrier, you connect your number to the voice agent with a SIP line, without changing number. In SupportFast you enter the number and the SIP access; at the phone carrier, or on the PBX, you route calls to the address the console gives you.
Who uses it: whoever manages the PBX or the VoIP contract. Where: in AccountTelephony, with Add number and then Create SIP number.
Read Connecting your PBX (SIP).
The webhook that starts an automation and the API node are available on plans that include “API and webhooks”: see Plans, quotas and usage.