وبهوکهای شرکت اطلاعات شرکت را پس از ایجاد یا ویرایش آن به آدرس مقصد ارسال میکنند. ساختار کلی Payload در هر دو رویداد یکسان است؛ با این تفاوت که در وبهوک ویرایش، آرایه changes مشخص میکند کدام اطلاعات شرکت در همان عملیات تغییر کردهاند.
اطلاعات کامل شرکتی است که وبهوک برای آن ارسال شده است. در وبهوک ایجاد، این Object وضعیت شرکتی تازه ایجادشده را نشان میدهد و در وبهوک ویرایش، آخرین وضعیت همان شرکت را پس از اعمال تغییرات در اختیار شما قرار میدهد.
شناسه شرکتی است که این وبهوک برای آن ارسال شده است. اگر رویداد از نوع ایجاد باشد، این مقدار شناسه شرکتی است که تازه در دیدار ایجاد شده و اگر رویداد از نوع ویرایش باشد، شناسه همان شرکتی است که اطلاعات آن تغییر کرده است.
نام خانوادگی ثبتشده برای این شرکت است. در رکورد شخص، نام خانوادگی مخاطب را نشان میدهد و در Payload شرکت ممکن است به دلیل استفاده از ساختار مشترک اطلاعات تماس ارسال شود.
نامی است که دیدار برای نمایش این شرکت در فهرستها، جستوجو و ارتباطات استفاده میکند. این مقدار میتواند از ترکیب نام، نام خانوادگی یا عنوان رکورد ساخته شده باشد.
شناسه شرکتی است که این رکورد به آن متصل شده است. در رکورد شخص، شرکت محل کار یا شرکت مرتبط با مخاطب را نشان میدهد؛ در Payload شرکت ممکن است از ساختار مشترک مخاطبان آمده باشد.
مشخص میکند تاریخ تولد ثبتشده از نظر ساختار داده معتبر است یا خیر. مقدار true یعنی تاریخ قابل استفاده است و مقدار false یعنی نباید بهعنوان تاریخ تولد معتبر پردازش شود.
مشخص میکند کاربر یا Context فعلی اجازه ویرایش این شرکت را دارد یا خیر. مقدار true یعنی ویرایش مجاز است و مقدار false یعنی اطلاعات رکورد قابل ویرایش نیست.
مشخص میکند این شرکت متعلق به کاربر فعلی محسوب میشود یا خیر. مقدار true یعنی رکورد در حوزه مالکیت یا مسئولیت کاربر فعلی است و مقدار false یعنی متعلق به کاربر دیگری است.
مشخص میکند کاربر یا Context فعلی اجازه مشاهده این شرکت را دارد یا خیر. مقدار true یعنی دسترسی وجود دارد و مقدار false یعنی مشاهده رکورد براساس قوانین دسترسی مجاز نیست.
اطلاعات پسزمینه و توضیحات تکمیلی ثبتشده درباره این شرکت است. این متن میتواند سابقه ارتباط، نیازها یا نکات مهمی را نگهداری کند که برای پیگیریهای بعدی لازماند.
نام شرکت ثبتشده در اطلاعات همین رکورد است. این مقدار در Payload شرکت میتواند با عنوان نمایشی شرکت یکسان یا بخشی از ساختار مشترک اطلاعات مخاطبان باشد.
مقادیر فیلدهای اضافهای است که برای شرکت تعریف شده و روی همین رکورد ثبت شدهاند. نام هر property کلید فنی فیلد اضافه و مقدار آن داده ثبتشده در همان فیلد است.
فهرست سگمنتهایی است که این شرکت عضو آنهاست. هر عضو Array یک گروهبندی از مخاطبان را نشان میدهد که برای دستهبندی، فیلتر یا اجرای فرایندهای هدفمند استفاده میشود.
تغییراتی که باعث ارسال وبهوک ویرایش شرکت شدهاند در این Array قرار میگیرند. در وبهوک ایجاد، changes خالی است؛ چون شرکت تازه ساخته شده و نسخه قبلیای برای مقایسه وجود ندارد. در وبهوک ویرایش، هر عضو مشخص میکند کدام فیلد تغییر کرده، مقدار آن پیش از ویرایش چه بوده و پس از ویرایش به چه مقداری تبدیل شده است. Object data وضعیت نهایی شرکت را نشان میدهد و changes فقط تغییرات همان عملیات را گزارش میکند.
مقدار فیلد پیش از انجام این ویرایش است. با مقایسه آن با changes[].after میتوانید دقیقاً تشخیص دهید اطلاعات شرکت از چه مقداری تغییر کرده است. نوع مقدار به فیلد نوشتهشده در propertyName بستگی دارد و میتواند رشته، عدد، Boolean، Object، Array یا null باشد.
اطلاعات فنی مربوط به خود رویداد وبهوک است، نه اطلاعات شرکت. این Object مشخص میکند چه عملیاتی انجام شده، رویداد متعلق به کدام بیزدامنه و شرکت است، چه کاربری آن را ایجاد کرده، تغییر از چه منبعی آمده و Payload توسط کدام تنظیم وبهوک و در چندمین تلاش ارسال شده است.
شناسه شرکتی است که رویداد وبهوک برای آن ثبت شده است. این مقدار باید به همان رکوردی اشاره کند که اطلاعات کامل آن داخل data قرار گرفته و معمولاً با data.Id یکسان است.
شناسه رویدادی است که پس از ایجاد یا ویرایش شرکت در سیستم ثبت شده و این Payload براساس آن ساخته شده است. این شناسه مربوط به خود رویداد است، نه شناسه شرکت.
مشخص میکند تغییر شرکت در قالب یک عملیات گروهی انجام شده است یا خیر. مقدار true یعنی این رویداد نتیجه ویرایش گروهی بوده و مقدار false یعنی شرکت بهصورت تکی ایجاد یا ویرایش شده است.
زمانی است که رویداد ایجاد یا ویرایش شرکت در دیدار ثبت شده و Payload وبهوک براساس آن تولید شده است. این زمان لزوماً با تاریخهای داخل خود شرکت یکسان نیست.
شناسه کاربری است که عملیات منجر به ارسال این وبهوک را انجام داده است. در رویداد ایجاد، کاربری را نشان میدهد که شرکت را ساخته و در رویداد ویرایش، کاربری را مشخص میکند که تغییر را انجام داده است.
شناسه تنظیم وبهوکی است که این Payload را به آدرس مقصد ارسال کرده است. این مقدار برای تشخیص وبهوک تعریفشدهای که رویداد از طریق آن ارسال شده کاربرد دارد.
وبهوک ایجاد شرکت زمانی ارسال میشود که یک شرکت جدید با موفقیت در دیدار ثبت شود. آبجکت data شامل اطلاعات شرکت تازه ایجادشده است و آرایه changes خالی ارسال میشود، چون پیش از این عملیات رکوردی وجود نداشته که فیلدی از آن تغییر کرده باشد.
وبهوک ویرایش شرکت زمانی ارسال میشود که حداقل یکی از اطلاعات موجود در data تغییر کند. فیلدهایی که تغییر آنها میتواند باعث ارسال این وبهوک شود عبارتاند از:
data.Id
data.Code
data.Title
data.FirstName
data.LastName
data.DisplayName
data.OwnerId
data.CompanyId
data.BirthDate
data.BirthDateisValid
data.BirthDateMessageId
data.MobilePhone
data.WorkPhone
data.WorkPhoneExtension
data.Fax
data.Email
data.CanDelete
data.CanEdit
data.IsDeleted
data.IsVIP
data.IsMine
data.HasAccess
data.LeadGenerationType
data.LeadStatus
data.LeadType
data.ContactType
data.IsCustomer
data.IsProspect
data.Type
data.BackgroundInfo
data.RegisterTime
data.Position
data.CustomerCode
data.EconomicIssue
data.NationalCode
data.RegistrationNumber
data.NationalID
data.ZipCode
data.CityTitle
data.ProvinceTitle
data.ProvinceId
data.CityId
data.HasCompany
data.CompanyName
data.CompanyIsCustomer
data.CompanyIsProspect
data.CompanyCode
data.CompanyAndPosition
data.Feedback
data.VisibilityType
data.OtherPhones
data.OtherEmails
data.Websites
data.Addresses
data.BankAccounts
data.Segments[].Id
data.Segments[].Title
data.LastUpdateTime
اگر هیچکدام از فیلدهای موجود در data تغییر نکنند، وبهوک ویرایش شرکت ارسال نمیشود. آرایه changes عامل Trigger نیست؛ این آرایه نتیجه تغییرات انجامشده را گزارش میکند و data آخرین وضعیت شرکت را پس از ویرایش نشان میدهد.
.svg?fit=max&auto=format&n=5dFUa43uNFVHhpls&q=85&s=0676273c9e1c58f0a7d6694269d14045)