רשומות

יצירת רשומה

POST/api/v1/webhook

יצירת רשומה חדשה בישות מסוימת. הנתונים נשלחים כאובייקט עם שמות השדות כמפתחות. שדות חובה נבדקים אוטומטית. האירוע record_created מופעל לאוטומציות.

אימות

Authorizationstringheaderחובה

כותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.

⚠️

שדות מקושרים פולימורפיים

חלק מהאובייקטים המובנים במערכת (כגון משימות, פגישות, שיחות) מכילים שדה "משוייך ל" שיכול להצביע על אובייקטים שונים — לידים, אנשי קשר, חשבונות וכו'. שדה כזה נקרא פולימורפי. כאשר יוצרים רשומה מסוג זה דרך ה-API, חייבים לשלוח שני ערכים: את ה-recordId של הרשומה המקושרת, ואת ה-entityId של האובייקט שאליו היא שייכת — כי המערכת לא יכולה לנחש אותו לבד. ניתן לקבל את ה-entityId הנכון דרך פעולת get_entities — הוא קבוע ולא משתנה, כך שאפשר לשמור אותו כערך קבוע בתרחיש.

{
  "action": "create",
  "entity": "tasks",
  "data": {
    "Subject": "מעקב אחרי ליד",
    "Status": "Open",
    "AssignTo": "RECORD_ID_של_הליד",
    "AssignTo__entityId": "ENTITY_ID_של_אובייקט_הלידים"
  }
}

פרמטרים

entitystringחובה

הslug של הישות

datajsonחובה

אובייקט עם ערכי השדות

תשובה

200 — application/json

successbooleanחובה

מציין אם הבקשה הצליחה

dataobject

אובייקט המכיל את נתוני התשובה

יצירת רשומה

const response = await fetch('https://crm.heybase.co.il/api/v1/webhook', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "action": "create",
  "entity": "contacts",
  "data": {
    "full_name": "ישראל ישראלי",
    "email": "israel@example.com",
    "phone": "050-1234567",
    "status": "חדש"
  }
}),
})
const data = await response.json()

200

{
  "success": true,
  "recordId": "rec_abc123def456",
  "message": "Record created successfully"
}

שגיאה

{
  "success": false,
  "error": "Validation failed: Missing required field: full_name"
}

בעמוד זה