Webhook
نتیجه‌ها کجا تحویل داده می‌شوند، کدام رویداد به کجا می‌رود، و هشدارهایی که می‌گویند کسی گوش نمی‌دهد
نقطهٔ پایانی وب‌هوک نشانی‌ای (URL) متعلق به شماست که هم‌زمان با انجام احراز هویت‌ها، رویدادها را به آن ارسال می‌کنیم. این راهی است که سامانه‌های خود شما بدون پرس‌وجوی مداوم از ما، از نتیجه باخبر می‌شوند.
ثبت یک نقطهٔ پایانی کار کسی است که سرورهای شما را اداره می‌کند. خواندن این صفحه برای فهمیدن اینکه چرا چیزی نرسیده، کار هر کسی است.
ثبت یک نقطهٔ پایانی
یک نشانی HTTPS که در اختیار خودتان است به ما بدهید. محتوای امضاشدهٔ رویدادها را به آن ارسال می‌کنیم. محیط هنگام ثبت نقطهٔ پایانی تعیین می‌شود و بعداً قابل تغییر نیست، پس نقطهٔ پایانی سندباکس برای همیشه نقطهٔ پایانی سندباکس می‌ماند.
توضیح اختیاری، برچسب خود شماست. ارزش دارد پرش کنید، چون مسیریابی بر اساس کلید باعث می‌شود دو نقطهٔ پایانی روی یک میزبان کاملاً عادی باشد، و نام چیزی است که آن‌ها را در فهرست از هم جدا می‌کند.
راز امضا یک بار هنگام ساخت نقطهٔ پایانی نمایش داده می‌شود، و اگر آن را عوض کنید یک بار دیگر. عوض کردن، آن را بی‌درنگ و بدون هم‌پوشانی جایگزین می‌کند، پس تا وقتی راز جدید در سمت شما مستقر نشود، تحویل‌ها در بررسی امضای شما رد می‌شوند. هر دو اقدام کدی از اپلیکیشن احراز هویت شما می‌خواهند.
انتخاب رویدادها
هر نقطهٔ پایانی فقط رویدادهایی را دریافت می‌کند که مشترکشان است. رویدادهای رایج:
| رویداد | چه زمانی اجرا می‌شود |
|---|---|
verification.created | یک جلسه ساخته شد |
verification.approved | حکم، تأیید است |
verification.rejected | حکم، رد است |
verification.review | حکم، بررسی است و یک نفر باید به آن نگاه کند |
verification.expired | متقاضی جلسه را به‌موقع کامل نکرد |
verification.corrected | نتیجه‌ای که پیش‌تر برایتان فرستادیم اشتباه بود و اصلاح شده است |
verification.data_updated | کسی در تیم شما اطلاعات متقاضی را ویرایش کرد. نتیجه تغییری نکرده است؛ برای مقادیر جدید، احراز هویت را دوباره دریافت کنید |
verification.completed | جلسه، برای هر نتیجه‌ای، به وضعیت پایانی رسید |
نقطهٔ پایانی جدید با رویدادهای approved، rejected، review، expired و verification.data_updated که از
پیش انتخاب شده‌اند شروع می‌شود، و می‌توانید پیش از ذخیره انتخاب را تغییر دهید. به هر نقطهٔ پایانی که پیش
از امکان ویرایش اطلاعات متقاضی وجود داشت و دست‌کم مشترک یک رویداد بود، verification.data_updated به‌طور
خودکار اضافه شد.
فهرست کامل، همراه با محتوای هر رویداد، در رویدادهای وب‌هوک آمده است.
هم‌زمان مشترک completed و رویدادهای مخصوص هر حکم نشوید
verification.completed در کنار رویدادهای حکم اجرا می‌شود، پس انتخاب هر دو هر نتیجه را دو بار تحویل
می‌دهد. انتخابگر وقتی در آستانهٔ این کار باشید به شما هشدار می‌دهد.
نقطهٔ پایانی‌ای که مشترک هیچ رویدادی نیست هیچ چیزی دریافت نمی‌کند، و فهرست این را صریح می‌گوید. همین‌طور دربارهٔ نقطهٔ پایانی‌ای که مشترک نام رویدادی است که دیگر هیچ چیزی آن را ارسال نمی‌کند.
مسیریابی بر اساس کلید API
هر رویداد با کلید APIای که جلسه را ساخته تطبیق داده می‌شود، و به این ترتیب حسابی که چند کسب‌وکار را اداره می‌کند نتیجه‌های هر کدام را به سامانهٔ خود همان کسب‌وکار می‌فرستد.
هر نقطهٔ پایانی یا روی همهٔ کلیدهای API تنظیم شده است، یعنی همهٔ احراز هویت‌های آن محیط از جمله جلسه‌هایی که بدون کلید ساخته شده‌اند، یا به کلیدهای مشخصی محدود شده است.
کنسول دو حالتی را که این کار ممکن است خراب شود زیر نظر دارد و پیش از مشتریانتان به شما خبر می‌دهد.
کلیدی که هیچ نقطهٔ پایانی‌ای آن را دریافت نمی‌کند. ساختن یک کلید API آن را مشترک هیچ چیزی نمی‌کند، پس احراز هویت‌هایی که با آن ساخته می‌شوند به جایی نمی‌روند تا وقتی آن را به یک نقطهٔ پایانی اضافه کنید یا یک نقطهٔ پایانی را روی همهٔ کلیدها تنظیم کنید.
هیچ نقطهٔ پایانی‌ای جلسه‌های بدون کلید را دریافت نمی‌کند. احراز هویتی که از همین کنسول شروع شود هیچ کلید APIای ندارد، پس فقط به نقطهٔ پایانی‌ای می‌رسد که روی همهٔ کلیدها تنظیم شده باشد. اگر همهٔ نقطه‌های پایانی به کلیدهای مشخص محدود باشند، این جلسه‌ها به هیچ جا تحویل داده نمی‌شوند.
آزمایش پیش از اعتماد
ارسال رویداد آزمایشی همین حالا یک محتوای نمونه را، امضاشده با راز فعلی، به نقطهٔ پایانی ارسال می‌کند. این محتوا دربارهٔ هیچ‌کس نیست: شناسه‌های درون آن آشکارا ساختگی‌اند و پوشش آن به‌عنوان آزمایشی علامت خورده است، پس کد دریافت‌کنندهٔ شما می‌تواند آن را از ترافیک واقعی تشخیص دهد. بدنهٔ آن در باقی موارد با آنچه واقعاً می‌فرستیم یکسان است، پس کدی که آزمایش را بپذیرد، نسخهٔ واقعی را هم می‌پذیرد.
میان دو آزمایش فاصلهٔ کوتاهی لازم است.
زیر نظر داشتن تحویل‌ها
هر نقطهٔ پایانی پنلی دارد که ترافیک اخیر را نشان می‌دهد: همه‌چیز پذیرفته شد، چیزی در انتظار نیست، چیزی دوباره تلاش نشد، یا اگر خطایی هست، خطاها. اگر اصلاً چیزی ارسال نشده باشد، صریح همین را می‌گوید.
سابقهٔ تحویل از گزارش‌های یکپارچه‌سازی می‌آید، پس نقشی که به گزارش‌ها دسترسی ندارد نقطهٔ پایانی را می‌بیند اما محتوای ارسال‌ها را نه. این محدودیت به این دلیل وجود دارد که محتوای ذخیره‌شده، رونوشت کلمه‌به‌کلمهٔ چیزی است که دربارهٔ یک متقاضی فرستاده‌ایم.
برای سابقهٔ کامل، فیلترها و امکان ارسال دوبارهٔ یک تحویل مشخص، به گزارش‌ها بروید.
غیرفعال‌کردن و حذف
غیرفعال‌کردن تحویل‌ها را تا وقتی دوباره فعالش کنید متوقف می‌کند، و این همان چیزی است که هنگام نگهداری سرورهای خود می‌خواهید. حذف دائمی است و دیگر اصلاً به آن نشانی ارسال نمی‌کنیم.
هیچ‌کدام احراز هویت‌ها را از بین نمی‌برد. رویدادهایی که تحویل داده نشدند دوباره تلاش می‌شوند، و بعداً می‌توان یک تحویل را دستی دوباره فرستاد.
خبردار شدن وقتی چیزی خراب می‌شود
نشانی‌های هشدار توسعه‌دهنده را در تنظیمات اضافه کنید تا وقتی یکپارچه‌سازی شما رویدادی را از دست می‌دهد به آن‌ها ایمیل بزنیم. هشدارهای مربوط به یک نقطهٔ پایانی با هم دسته‌بندی می‌شوند، پس یک قطعی یک پیام است نه یک پیام برای هر رویداد ازدست‌رفته. بدون آن‌ها به هیچ‌کس خبر داده نمی‌شود.