Skip to main content

وب‌هوک‌های فعالیت

وب‌هوک‌های فعالیت اطلاعات یک فعالیت را پس از ایجاد یا ویرایش آن به آدرس مقصد ارسال می‌کنند. ساختار کلی Payload در هر دو رویداد یکسان است و Object data آخرین وضعیت فعالیت را در زمان ارسال نشان می‌دهد. تفاوت اصلی دو رویداد در changes است؛ در وب‌هوک ایجاد این Array خالی است و در وب‌هوک ویرایش، فیلدهای تغییرکرده همراه با مقدار قبلی و مقدار جدید در آن قرار می‌گیرند.

ساختار داده ارسالی

object
اطلاعات کامل فعالیتی که وب‌هوک برای آن ارسال شده است. در وب‌هوک ایجاد، این Object وضعیت فعالیت تازه ایجادشده را نشان می‌دهد و در وب‌هوک ویرایش، آخرین وضعیت همان فعالیت را پس از اعمال تغییرات در اختیار شما قرار می‌دهد.
array
تغییراتی که باعث ارسال وب‌هوک ویرایش فعالیت شده‌اند در این Array قرار می‌گیرند. در وب‌هوک ایجاد، changes خالی است؛ چون فعالیت تازه ساخته شده و نسخه قبلی‌ای وجود ندارد که با آن مقایسه شود. در وب‌هوک ویرایش، هر عضو این Array مشخص می‌کند کدام فیلد فعالیت تغییر کرده، مقدار آن قبل از ویرایش چه بوده و پس از ویرایش به چه مقداری تبدیل شده است. Object data وضعیت نهایی فعالیت را نشان می‌دهد و changes فقط تغییرات همان عملیات ویرایش را گزارش می‌کند.
object
اطلاعات فنی مربوط به خود رویداد وب‌هوک است، نه اطلاعات فعالیت. این Object مشخص می‌کند چه عملیاتی انجام شده، رویداد متعلق به کدام بیزدامنه و فعالیت است، چه کاربری آن را ایجاد کرده، تغییر از چه منبعی آمده و Payload توسط کدام تنظیم وب‌هوک و در چندمین تلاش ارسال شده است.

وب‌هوک ایجاد فعالیت چه زمانی ارسال می‌شود؟

وب‌هوک ایجاد فعالیت زمانی ارسال می‌شود که یک فعالیت جدید با موفقیت در دیدار ثبت شود. Object data شامل اطلاعات فعالیت تازه ایجادشده است. Array changes در این رویداد خالی ارسال می‌شود؛ زیرا رکورد برای اولین بار ساخته شده و نسخه قبلی برای مقایسه وجود ندارد.

وب‌هوک ویرایش فعالیت چه زمانی ارسال می‌شود؟

وب‌هوک ویرایش فعالیت زمانی ارسال می‌شود که حداقل یکی از فیلدهای موجود در Object data تغییر کند. فیلدهای قابل گزارش در این Payload عبارت‌اند از: اطلاعات اصلی
  • data.Id — تغییر شناسه رکورد
  • data.Title — تغییر عنوان
  • data.Note — تغییر متن توضیح اولیه
  • data.ResultNote — تغییر نتیجه ثبت‌شده
  • data.ActivityTypeId — تغییر نوع فعالیت
  • data.Duration — تغییر مدت
وضعیت و تنظیمات
  • data.IsPrivate — تغییر وضعیت خصوصی‌بودن
  • data.IsDone — تغییر وضعیت انجام‌شدن
  • data.IsPinned — تغییر وضعیت پین‌شدن
  • data.IsDeleted — تغییر وضعیت حذف
  • data.DueDateType — تغییر نوع زمان‌بندی
  • data.RecurrenceType — تغییر نوع تکرار
  • data.RecurrenceData — تغییر تنظیم تکرار
  • data.FeedbackType — تغییر نوع بازخورد
  • data.CanPoke — تغییر امکان Poke
  • data.IsAttended — تغییر وضعیت حضور
  • data.IsTicket — تغییر وضعیت تیکت‌بودن
  • data.ActivityGroupType — تغییر نوع گروه فعالیت
ارتباطات و کاربران
  • data.DealId — تغییر معامله مرتبط
  • data.CaseId — تغییر کارت مرتبط
  • data.CreatorId — تغییر ایجادکننده رکورد
  • data.OwnerId — تغییر مسئول رکورد
  • data.UpdaterId — تغییر آخرین ویرایش‌کننده
  • data.ActivityGroupId — تغییر گروه فعالیت
  • data.ContactIds — تغییر اشخاص مرتبط
  • data.ContactIds[] — تغییر اشخاص مرتبط
  • data.CompanyIds — تغییر شرکت‌های مرتبط
  • data.UserIds — تغییر کاربران مرتبط
  • data.Attachments — تغییر پیوست‌ها
  • data.Tags — تغییر تگ‌ها
زمان‌ها
  • data.DueDate — تغییر زمان سررسید
  • data.FinishDate — تغییر زمان پایان برنامه‌ریزی‌شده
  • data.OriginalDueDate — تغییر زمان سررسید اولیه
  • data.DoneDate — تغییر زمان انجام
  • data.RegisterDate — تغییر زمان ایجاد
  • data.LastUpdateTime — تغییر زمان آخرین ویرایش
  • data.LastPokeDate — تغییر زمان آخرین Poke
  • data.RecurrenceEndDate — تغییر زمان پایان تکرار
  • data.NextOccurrence — تغییر زمان رخداد بعدی
اگر هیچ‌کدام از فیلدهای موجود در data تغییر نکنند، وب‌هوک ویرایش فعالیت ارسال نمی‌شود. Array changes عامل Trigger نیست؛ این Array فقط فیلدهای تغییرکرده را گزارش می‌کند و data وضعیت نهایی فعالیت را پس از ویرایش نشان می‌دهد.

نمونه داده ارسالی