אירועים
הרשמה ל-Webhook
POST
/api/v1/webhookרישום URL לקבלת התראות בזמן אמת כשמתרחשים אירועים במערכת. תקבלו secret ייחודי לאימות כל הודעה.
אימות
Authorizationstringheaderחובהכותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.
פרמטרים
urlstringחובהכתובת URL לשליחת האירועים
eventsarrayחובהמערך סוגי אירועים להאזנה
תשובה
200 — application/json
successbooleanחובהמציין אם הבקשה הצליחה
dataobjectאובייקט המכיל את נתוני התשובה
הרשמה ל-Webhook
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": "subscribe_webhook",
"url": "https://my-server.com/webhooks/heybase",
"events": [
"record.created",
"record.updated",
"record.deleted"
]
}),
})
const data = await response.json()200
{
"success": true,
"data": {
"subscriptionId": "sub_abc123",
"secret": "whsec_a1b2c3d4e5f6..."
}
}בעמוד זה
