Overview
What is an API?
An API (Application Programming Interface) lets you request or send data between systems, on demand. You control when and how the request is made.
-
You pull data when needed
-
Used for: fetching user profiles, sending messages, creating chats
-
Example in ConverseIQ:
GET https://api.converseiq.com.au/public/v1/chatWhat is a webhook?
A webhook is a system that sends data automatically when something happens. Instead of you calling the API, the system pushes data to your URL when triggered.
-
Data is sent to your server automatically
-
Used for: getting notified of new messages, chat events, contact updates
-
You need to set up a public URL that can receive POST requests
-
Example: ConverseIQ sends a webhook to your n8n workflow when a new message arrives
When to use which
| Use case | Use API | Use Webhook |
|---|---|---|
| Display data on request | ✅ | ❌ |
| Automate action when something happens | ❌ | ✅ |
| Need control over timing | ✅ | ❌ |
| React to real-time events | ❌ | ✅ |
