חתימות
יצירת חתימה
POST
/api/v1/webhookיצירת בקשת חתימה דיגיטלית חדשה מתבנית קיימת. ניתן לשלוח באימייל או SMS. ניתן למלא ערכים מראש בשדות התבנית ולשייך לרשומה.
אימות
Authorizationstringheaderחובהכותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.
פרמטרים
templateIdstringחובהמזהה תבנית המסמך
recipientNamestringחובהשם הנמען
recipientEmailstringאימייל הנמען (חובה אם שליחה באימייל)
recipientPhonestringטלפון הנמען (חובה אם שליחה ב-SMS)
sendViastringערוץ שליחה: email (ברירת מחדל) או sms
recordIdstringמזהה רשומה לשיוך
entitySlugstringslug הישות של הרשומה המשויכת
prefillDatajsonערכים למילוי מראש בשדות התבנית
תשובה
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_signature",
"templateId": "tpl_abc123",
"recipientName": "ישראל ישראלי",
"recipientEmail": "israel@example.com",
"sendVia": "email",
"recordId": "rec_xyz789",
"entitySlug": "contacts",
"prefillData": {
"company": "חברה בע\"מ",
"amount": "10,000"
}
}),
})
const data = await response.json()200
{
"success": true,
"data": {
"signatureRequestId": "sig_req_001",
"signingUrl": "https://crm.heybase.co.il/sign/sig_1711234567_abc123"
}
}בעמוד זה
