📖
סקירה כללית
ברוכים הבאים לתיעוד API של HeyBase CRM
מה זה HeyBase API?
API של HeyBase מאפשר לך לתקשר עם מערכת ה-CRM באופן תכנותי. ניתן ליצור, לעדכן, למחוק ולחפש רשומות, לנהל משתמשים, להפעיל אוטומציות ועוד.
נקודת כניסה
POST
https://crm.heybase.co.il/api/v1/webhookמבנה בקשה
כל הבקשות נשלחות כ-POST עם גוף JSON. כל בקשה חייבת לכלול את שם הפעולה ופרמטרים רלוונטיים.
{
"action": "search_records",
"params": {
"entity": "contacts",
"filters": {
"email": "user@example.com"
}
}
}מבנה תשובה
כל תשובה מוחזרת ב-JSON עם שדה success ושדה data או error.
{
"success": true,
"data": {
"records": [...],
"total": 42
}
}