وبهوک امکانی است که وقوع یک رویداد را به سرویس دهنده نرم افزاری بیرونی خبر می دهد. به عبارت دیگر وقتی یه اتفاق خاصی توی دیدار می‌افته (مثلاً یه معامله جدید ثبت می‌شه)، ما به صورت خودکار همون لحظه یه پیام حاوی اطلاعات اون اتفاق رو برای یه آدرس اینترنتی (که شما تعیین کردین) می‌فرستیم.
معرفی وبهوک
چه چیزهایی رو می‌تونید با وبهوک دنبال کنید؟ #
وبهوک می تواند در زمان اتفاق افتادن رویداد های ایجاد و ویرایش برای معامله/کارت/شخص/شرکت/فعالیت/یادداشت/محصول اجرا شود
وقتی یه معامله جدید ثبت می‌شه چی فرستاده می‌شه؟ #
ما یه بسته اطلاعاتی از آن موجودیت را به آدرسی که شما تعیین کرده اید ارسال می کنیم. متد ارسال اطلاعات POST می باشد. بسته اطلاعاتی شامل سه بخش است. بخش data که جزئیات پراپرتی های موجدویت با آخرین مقادیر می باشد. بخش changes که به صورت خاص تعیین می کند که مقدار کدام پراپرتی تغییر کرده و مقدار قدیم و جدید آن چه بوده است. بخش meta اطلاعات تکمیلی رویداد را مشخص می کند. در ادامه یک مثال آماده است
{
“data”: {
“Id”: “شناسه معامله”,
“OwnerId”: “مالک”,
“PersonId”: “مشتری مربوطه”,
“Title”: “عنوان معامله”,
“Price”: “مبلغ”,
“RegisterTime”: “زمان ثبت”,
…
},
“changes”: [
{
“propertyName”: “Status”,
“before”: “وضعیت قبلی”,
“after”: “وضعیت جدید”
}
],
“meta”: {
“timeStamp”: “زمان دقیق اتفاق”,
“userId”: “کاربری که این کار رو کرده”,
…
}
}
دقت کنید که مقادیر فارسی نیستن اما اینجا برای فهم مسئله و نمایش ساختار دیتاهای ارسالی به صورت زیر با مقادیر فارسی نمایش داده شده است
روش ایجاد وبهوک در دیدار #
برای ساخت یک وبهوک در دیدار، مراحل زیر را به ترتیب انجام دهید:
- وارد پنل کاربری دیدار شوید.
پس از ورود، از منوی سمت راست گزینه «وبهوک» را انتخاب کنید.- می توانید مستقیما به آدرس https://app.didar.me/settings;tab=webhook بروید
- روی دکمه «ایجاد وبهوک جدید» کلیک کنید.
- تنظیمات وبهوک را به‌صورت زیر انجام دهید:
- نوع رویداد:
انتخاب کنید که وبهوک در چه زمانی فعال شود: هنگام ایجاد، ویرایش یا حذف یک مورد. - نوع موجودیت (Entity):
مشخص کنید که وبهوک برای کدام نوع داده باشد؛ مانند معامله، کارت، شخص و … - عنوان وبهوک:
یک نام دلخواه برای این وبهوک وارد کنید تا بعداً راحت‌تر بتوانید هدف آن را تشخیص دهید (مثلاً «ایجاد معامله جدید»). - آدرس مقصد (URL):
آدرس سرویسی را وارد کنید که می‌خواهید اطلاعات رویداد به آن ارسال شود. این آدرس باید در دسترس باشد و قابلیت دریافت درخواست POST را داشته باشد.
- نوع رویداد:
- در پایان، روی دکمه «ذخیره» کلیک کنید تا وبهوک شما ایجاد شود.
توجه :
- وبهوک ها روی import و ویرایش گروهی اطلاعات کار نمی کند
موارد استفاده‌ی وبهوک چیه؟ به چه دردی می‌خوره؟ #
اگه شما یه سیستم حسابداری، فروشگاه اینترنتی، یا هر نرم‌افزار دیگه‌ای دارین که باید با دیدار در ارتباط باشه، وبهوک کمک می‌کنه همه‌چیز به‌صورت خودکار هماهنگ بشه. دیگه نیاز نیست دستی اطلاعات رو جابه‌جا کنین. چند مثال واقعی:
مهم ! دقت کنید که مثال های زیر نیاز به انجام برنامه نویسی و داشتن وب سرویس های سامانه های دیگر را دارد و فقط توسط برنامه نویس متخصص مستقر در شرکت شما و یا برنامه نویسانی که شما با آنها قرارداد مستقیم دارید قابل اجراست
- اتصال به نرم‌افزار های مالی یا سازمانی
وقتی معامله جدیدی ثبت یا ویرایش می‌شه، اطلاعاتش بره مستقیم توی سیستم شما هم به روز بشه.
اتصال به پنل پیامکی یا واتساپی
مثلاً وقتی مشتری جدیدی ثبت می‌شه، خودکار براش پیام خوش‌آمد بفرستین.
اتصال به سیستم انبار یا فروشگاه اینترنتی
وقتی محصول جدیدی اضافه شد یا قیمتش تغییر کرد، توی سایت شما هم آپدیت بشه. - گزارش‌گیری و داشبورد شخصی‌سازی‌شده
اطلاعاتی که از دیدار با وبهوک دریافت می‌کنین، می‌تونه توی یه داشبورد اختصاصی یا گزارش‌ساز بیرونی نمایش داده بشه.
اتوماسیون‌های سفارشی برای تیم فروش یا پشتیبانی
مثلاً وقتی یک فرصت فروش به مرحله «نهایی شده» رسید، یه کار خاصی مثل ایجاد تیکت در نرم‌افزار پشتیبانی انجام بشه.
