آشنایی با وبهوک در دیدار #
وبهوک (Webhook) روشی برای ارسال خودکار اطلاعات از دیدار به یک سیستم دیگر است. با استفاده از وبهوک میتوانید مشخص کنید هر زمان یک اتفاق مشخص در دیدار رخ داد، اطلاعات آن رویداد به آدرس موردنظر شما ارسال شود.
برای مثال، میتوانید بعد از ایجاد یا ویرایش یک معامله، شخص، فعالیت یا سایر اطلاعات در دیدار، سیستم دیگری را از این تغییر مطلع کنید.
وبهوک دیدار چطور کار میکند؟ #
فرآیند کلی وبهوک به این شکل است:
- یک رویداد در دیدار اتفاق میافتد؛ برای مثال یک معامله جدید ایجاد میشود.
- دیدار بررسی میکند که آیا برای این رویداد وبهوکی تعریف شده است یا خیر.
- در صورت وجود وبهوک، اطلاعات مربوط به رویداد به آدرس مقصدی که مشخص کردهاید ارسال میشود.
- سیستم مقصد اطلاعات دریافتی را پردازش میکند.
به این ترتیب، لازم نیست سیستم شما بهصورت مداوم دیدار را بررسی کند تا متوجه تغییرات شود؛ دیدار در زمان وقوع رویداد، اطلاعات را برای سیستم مقصد ارسال میکند.
وبهوک چه کاربردهایی دارد؟ #
وبهوک معمولاً زمانی استفاده میشود که میخواهید یک فرآیند در سیستم دیگری بلافاصله بعد از یک اتفاق در دیدار اجرا شود.
برای مثال میتوانید از وبهوک برای سناریوهایی مثل موارد زیر استفاده کنید:
- ارسال اطلاعات یک معامله جدید به یک نرمافزار دیگر
- شروع یک Workflow در ابزارهایی مثل n8n بعد از وقوع یک رویداد در دیدار
- همگامسازی اطلاعات دیدار با یک سیستم دیگر
- ارسال اطلاعات فاکتور یا پرداخت به یک سیستم مالی
- اجرای یک فرآیند خودکار بعد از ایجاد یا ویرایش اطلاعات در دیدار
پیادهسازی این سناریوها به سیستم مقصد و فرآیندی که میخواهید ایجاد کنید بستگی دارد.
چه وبهوکهایی در دیدار وجود دارد؟ #
دیدار برای موجودیتهای مختلفی مثل معامله، شخص، شرکت، فعالیت، محصول، فاکتور و موارد دیگر وبهوک در اختیار شما قرار میدهد.
برای هر وبهوک، مواردی مثل اینها اهمیت دارد:
- چه اتفاقی باعث فعالشدن وبهوک میشود؟
- چه اطلاعاتی بعد از فعالشدن ارسال میشود؟
- ساختار Payload ارسالی چگونه است؟
- هر فیلد موجود در Payload چه معنایی دارد؟
این جزئیات در هاب مستندات فنی دیدار بهصورت جداگانه برای هر نوع وبهوک مستند شده است.
برای مشاهده راهنمای شروع کار، لیست وبهوکها و مستندات کامل هرکدام، وارد بخش Webhook در هاب مستندات فنی دیدار شوید:
مشاهده مستندات فنی Webhook دیدار
در این بخش علاوه بر آشنایی با نحوه کار وبهوک، میتوانید نحوه ساخت و تست اولین وبهوک و مستندات فنی مربوط به Trigger و Payload هر رویداد را مشاهده کنید.
برای استفاده از وبهوک به چه چیزهایی نیاز دارید؟ #
برای ایجاد و مدیریت وبهوک در دیدار، باید با اکانت مدیر وارد شده باشید. همچنین باید آدرس مقصد یا Endpoint سیستمی که قرار است اطلاعات را دریافت کند در اختیار داشته باشید.
اگر قصد پیادهسازی یک Integration را دارید، پیشنهاد میکنیم قبل از شروع، مستندات فنی Webhook دیدار را بررسی کنید تا رویداد مناسب و ساختار اطلاعات ارسالی آن را بشناسید.
