אוטומציות
שליפת הרצות
POST
/api/v1/webhookקבלת היסטוריית הרצות של מסע לקוח מסוים. כולל סטטוס, מזהה רשומה ותאריכי התחלה וסיום.
אימות
Authorizationstringheaderחובהכותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.
פרמטרים
journeyIdstringחובהמזהה המסע
pagenumberמספר עמוד
limitnumberמספר תוצאות לעמוד (1-100)
תשובה
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": "get_executions",
"journeyId": "jrn_001",
"page": 1,
"limit": 10
}),
})
const data = await response.json()200
{
"success": true,
"data": [
{
"id": "exec_001",
"status": "completed",
"recordId": "rec_abc123",
"startedAt": "2024-03-25T10: 00: 00.000Z",
"completedAt": "2024-03-25T10: 15: 00.000Z",
"historyLength": 5
},
{
"id": "exec_002",
"status": "active",
"recordId": "rec_def456",
"startedAt": "2024-03-25T11: 00: 00.000Z",
"completedAt": null,
"historyLength": 2
},
{
"id": "exec_003",
"status": "failed",
"recordId": "rec_ghi789",
"startedAt": "2024-03-24T09: 00: 00.000Z",
"completedAt": "2024-03-24T09: 05: 00.000Z",
"historyLength": 3
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 3,
"hasMore": false
}
}בעמוד זה
