לדלג לתוכן הראשי

הגדרת וובהוק (Webhook)

עודכן לפני יותר משבוע

Webhook הוא מנגנון שמאפשר למערכת אחת לשלוח מידע בזמן אמת למערכת אחרת כשהתרחשה פעולה מסוימת. זה כמו "התראה חכמה" שנשלחת אוטומטית עם פרטים רלוונטיים, בלי צורך לבדוק ידנית.

אם אין לכם כתובת, מומלץ לפנות למתכנת/ת לסיוע.

אם כבר יש לכם כתובת Webhook, תוכלו להגדיר אותה כך:

לאחר התחברות לחשבון העמותה, היכנסו ל'הגדרות חשבון' > 'אינטגרציות' והזינו את כתובת ה- URL שלכם בשדה של ה- Webhook. לחצו בסוף על 'שמור'.

🧾 תיעוד שדות אירוע Webhook של תרומה

🔹 transfer – פרטי העברת התשלום

שדה

תיאור

id

מזהה ייחודי של ההעברה

completed_at

תאריך ושעה שההעברה הושלמה

refunded_at

תאריך ושעה שההעברה בוטלה (אם רלוונטי)

israeli_id

תעודת זהות של התורם בשלב ההעברה

israeli_id_source

מקור קבלת תעודת הזהות

amount

סכום ההעברה

currency

מטבע ההעברה

🔹 donation – פרטי התרומה

שדה

תיאור

donation_id

מזהה ייחודי של התרומה

created_at

תאריך יצירת התרומה

comment

הערה שנוספה על ידי התורם

share_donor_details_with_charities

האם לשתף את פרטי התורם עם העמותות

receive_updates_from_charities

האם לקבל עדכונים מהעמותות

purpose_he

מטרת התרומה (עברית)

purpose_en

מטרת התרומה (אנגלית)

checkout_locale

שפת המסך בעת התרומה

recurring

האם זו תרומה חוזרת

recurring_months

מספר חודשים לתרומה החוזרת

upcoming_transfer_count

מספר העברות שנותרו בתרומה חוזרת

next_transfer_at

תאריך ההעברה הבאה (אם רלוונטי)

recurring_end_date

תאריך סיום התרומה החוזרת

recurring_payment_number

מספר תשלום נוכחי מתוך סדרת תשלומים חוזרים

amount

סכום התרומה

norm_amount

סכום מנורמל של התרומה

amount_currency

מטבע התרומה

🔹 payment_method – אמצעי תשלום

שדה

תיאור

provider

ספק התשלום (לדוג' PayMe)

name

סוג אמצעי התשלום (כרטיס אשראי, ביט וכו')

card_last4

4 הספרות האחרונות של כרטיס האשראי

redirected

האם המשתמש הועבר לעמוד תשלום חיצוני

🔹 invoice – פרטי חשבונית

שדה

תיאור

id

מזהה החשבונית

number

מספר חשבונית

download_url

קישור להורדת חשבונית מקור

download_copy_url

קישור להורדת העתק חשבונית

tax_authority_confirmation_number

מספר אישור מרשויות המס (אם קיים)

🔹 donor – פרטי התורם

שדה

תיאור

email

כתובת האימייל של התורם

phone_number

מספר הטלפון של התורם

israeli_id

תעודת זהות של התורם

first_name

שם פרטי

last_name

שם משפחה

full_name

שם מלא

🔹 invoice_information – פרטי נמען החשבונית

שדה

תיאור

recipient_name

שם המופיע על החשבונית

company_id

ח.פ./ע.מ (אם רלוונטי)

address_1

שורת כתובת ראשונה

address_2

שורת כתובת שנייה (אם קיימת)

🔹 donation_target – יעד התרומה (משתתף, עמותה, אירוע)

שדה

תיאור

id

מזהה יעד התרומה

name_he

שם היעד בעברית

name_en

שם היעד באנגלית

to_charity_page

האם התרומה לעמותה

to_main_event

האם התרומה לאירוע ראשי

to_team

האם התרומה לקבוצה

team_id

מזהה הקבוצה (אם רלוונטי)

main_event_id

מזהה האירוע הראשי

🔹 participant – פרטי שגריר

שדה

תיאור

id

מזהה המשתתף

name_he

שם בעברית

name_en

שם באנגלית

email

אימייל המשתתף

phone_number

טלפון של המשתתף

send_email_notification

שליחת הודעת אימייל

send_whatsapp_notification

שליחת הודעת וואטסאפ

team_id

מזהה קבוצה (אם יש)

main_event_id

מזהה האירוע הראשי

האם קיבלת תשובה לשאלתך?