وب‌هوک‌ها: فرستادن هشدارهای CostGuard به ابزارهای شما
چگونه یک مقصد را ثبت کنید، رمز امضای آن را نگه دارید، هر تحویل را بررسی کنید و مقصدی را خاموش کنید، و CostGuard چه رویدادهایی را می‌فرستد.
این صفحه برای چیست
وب‌هوک‌ها هشدارهای فضای کاری را به سامانه‌هایی که خودتان اداره می‌کنید می‌فرستد، مانند یک ربات گفتگو، ابزار رسیدگی به رخدادها یا سرویس خودتان. این صفحه نشان می‌دهد کدام مقصدها کدام رویدادها را می‌گیرند و آیا تحویل‌های اخیر رسیده‌اند.
CostGuard هر تحویل را امضا می‌کند و تحویل ناموفق را طبق زمان‌بندی ثابت تا پنج بار دوباره تلاش می‌کند. تنها رویدادهای فهرست‌شده در پایین ارسال می‌شوند؛ چیز دیگری خارج نمی‌شود.
پیش از شروع
به این‌ها نیاز دارید:
- طرح Pro یا Enterprise؛ طرح‌های دیگر یک نمونه برچسب‌دار می‌بینند.
- یک نشانی HTTPS روی میزبانی عمومی که درخواست POST را بپذیرد و پیش از اعتماد به درخواست، امضا را بررسی کند.
ثبت مقصد
در «ثبت یک مقصد» این‌ها را پر کنید:
- «نام»: نامی کوتاه و ساده که در فهرست‌ها بشناسید.
- «نشانی مقصد»: باید یک نشانی HTTPS روی یک میزبان عمومی باشد. CostGuard بررسی نمی‌کند که نشانی در دسترس است یا متعلق به شماست.
- «رویدادهایی که ارسال شوند»: خطر بودجه شناسایی شد، خطر پیش‌بینی شناسایی شد و همگام‌سازی هزینه ناموفق بود، سه رویدادی که CostGuard امروز تولید می‌کند.
زیر «در حال حاضر تولید نمی‌شود» صفحه دسته‌های دیگر رویداد را نام می‌برد که قابل انتخاب نیستند: CostGuard این دسته‌های رویداد را نام می‌برد اما در حال حاضر هیچ‌کدام را ایجاد نمی‌کند، بنابراین قابل انتخاب نیستند. هرگز چیزی برای آن‌ها ارسال نخواهد شد.
«ثبت مقصد» مقصد را بی‌درنگ روشن می‌کند. هر فضای کاری تا ده مقصد می‌تواند ثبت کند و این بخش شمار مقصدهای به‌کاررفته را نشان می‌دهد.
رمز امضا
وقتی مقصدی ثبت می‌شود، صفحه «کلید امضا» آن را یک بار نشان می‌دهد. همین حالا آن را کپی کنید. تنها یک بار نمایش داده می‌شود و دوباره نمایش داده نخواهد شد؛ اگر آن را از دست بدهید کلید تازه‌ای صادر کنید که کلید قبلی را از کار می‌اندازد.
هر تحویل یک سرآیند X-CostGuard-Signature دارد که امضای HMAC-SHA256 ساخته‌شده با کلید امضای مقصد است، و یک سرآیند X-CostGuard-Timestamp. گیرنده‌ی شما پیش از اعتماد به درخواست، امضا را بررسی می‌کند.
«صدور کلید جدید» نخست می‌پرسد: رمز کنونی بی‌درنگ از کار می‌افتد و گیرنده شما تا وقتی رمز تازه را نداشته باشد تحویل‌ها را رد می‌کند.
مقصدهای ثبت‌شده
«مقصدهای ثبت‌شده» هر مقصد را با رویدادهایی که می‌گیرد، «وضعیت»، «آخرین تحویل» و «ثبت‌شده (UTC)» فهرست می‌کند. کنش‌های آن:
- «خاموش کردن» و «روشن کردن»: تا وقتی مقصدی خاموش است، تحویل تازه‌ای برای آن ساخته نمی‌شود؛ تحویلی که از پیش در انتظار بوده، پس از روشن شدن دوباره فرستاده می‌شود.
- «صدور کلید جدید»: رمز امضا را در بالا ببینید.
- «حذف»: همراه با کلید امضایش حذف می‌شود و دیگر چیزی به آن فرستاده نمی‌شود.
خاموش کردن، صدور رمز تازه و حذف هر کدام نخست تأیید می‌خواهند؛ روشن کردن بی‌درنگ انجام می‌شود.
تحویل‌های اخیر
جدیدترین تحویل‌های این فضای کاری، حداکثر صد مورد، از جدیدترین به قدیمی‌ترین. زمان‌ها به وقت UTC است. هر تحویل یک وضعیت دارد:
- «تحویل شد»: نقطه پایانی شما آن را پذیرفت.
- «در انتظار»: تلاش خواهد شد، یا طبق برنامه ثابت دوباره تلاش می‌شود.
- «رد شد»: نقطه پایانی شما آن را رد کرد یا نشانی قابل فراخوانی نیست؛ دوباره تلاش نمی‌شود.
- «رها شد»: پنج بار تلاش شد بی آن‌که نقطه پایانی شما آن را به‌موقع بپذیرد.
«تلاش‌ها» شمار تلاش‌ها را نشان می‌دهد و «جزئیات» به زبان ساده می‌گوید چه رخ داد، مانند «نقطهٔ پایانی شما به‌موقع پاسخ نداد» یا «نقطهٔ پایانی شما درخواست را رد کرد». تحویلی به مقصدی که بعداً حذف شده «مقصدی که حذف شده است» را نشان می‌دهد.
وب‌هوک‌ها چگونه کار می‌کنند
تحویلی که نقطه‌ی پایانی شما به‌موقع نپذیرفته باشد پس از یک، پنج، پانزده و شصت دقیقه دوباره تلاش می‌شود، در مجموع پنج تلاش؛ پس از پنجمین تلاش به‌صورت «رها شد» نشان داده می‌شود. تحویلی که نقطه‌ی پایانی شما رد کرده باشد، یا نشانی‌ای که CostGuard اجازه‌ی فراخوانی‌اش را ندارد، دوباره تلاش نمی‌شود.
رویدادها همان هشدارهایی را می‌برند که فضای کاری بر پایه «قوانین هشدار» پدید می‌آورد؛ رویداد فقط وقتی فرستاده می‌شود که چنین هشداری پدید آید.
وب‌هوک‌ها جدا از هشدارهای ایمیلی و درون‌برنامه‌ای‌اند: «تنظیمات اعلان» آن‌ها را تنظیم می‌کند و «تاریخچه تحویل هشدارها» فهرستشان را نشان می‌دهد.
آنچه ممکن است به‌جای ارقام ببینید
تا وقتی صفحه می‌خواند، نوارهای خاکستری جای پنل‌ها را می‌گیرند. پس از آن، صفحه ممکن است به جای آن‌ها یکی از این حالت‌ها را نشان دهد:
- «مقصدهای ثبت‌شده خوانده نشد»: این بدان معنا نیست که فضای کاری هیچ مقصدی ندارد. دوباره تلاش کنید.
- این فضای کاری هیچ مقصدی ثبت نکرده است.
- «تحویل‌های اخیر خوانده نشد»: این بدان معنا نیست که چیزی تحویل داده نشده است. برای تلاش دوباره صفحه را بارگیری مجدد کنید.
- CostGuard نتوانست تأیید کند که این تغییر ذخیره شده است. فهرست زیر وضعیت فعلی فضای کاری را نشان می‌دهد.
وقتی طرح شما وب‌هوک را در بر ندارد
در Free، Starter و Growth صفحه نمونه‌ای ثابت با برچسب «داده‌های نمونه» و این جمله نشان می‌دهد: «طرح فعلی شما این قابلیت را شامل نمی‌شود. ارقام نمایش‌داده‌شده در اینجا نمونه هستند، نه داده‌های شما.»
نمونه مقصدها و تحویل‌های ساختگی را بدون دکمه، بدون رمز و بدون هیچ نشانی‌ای از شما نشان می‌دهد.
«مقایسه طرح‌ها» صفحهٔ قیمت‌ها را در زبانهٔ تازه باز می‌کند. CostGuard روی سرور تصمیم می‌گیرد طرح شما چه چیزهایی را شامل می‌شود؛ نمونه فقط شیوهٔ نمایش آن در صفحه است.
هر طرح چه چیزهایی دارد
جدول نخستین طرحی را نشان می‌دهد که هر بخش صفحه را دارد. همهٔ طرح‌های بالاتر هم آن را دارند.
| قابلیت | Free | Starter | Growth | Pro | Enterprise |
|---|---|---|---|---|---|
| نمونهٔ برچسب‌دار از صفحه | شامل می‌شود | شامل می‌شود | شامل می‌شود | شامل می‌شود | شامل می‌شود |
| ثبت مقصد و فرستادن رویداد | شامل نمی‌شود | شامل نمی‌شود | شامل نمی‌شود | شامل می‌شود | شامل می‌شود |
Pro و Enterprise وب‌هوک را دارند؛ Free، Starter و Growth نمونه برچسب‌دار را نشان می‌دهند. طرح روی سرور بررسی می‌شود و صفحه هرگز قیمتی نشان نمی‌دهد.
رفع اشکال
گیرنده من امضا را رد می‌کند
گیرنده رمزی قدیمی یا اشتباه دارد. رمز تازه صادر کنید، بی‌درنگ آن را در گیرنده ذخیره کنید و بررسی کنید که امضا روی درخواست همان‌گونه که دریافت شده محاسبه می‌شود.
تحویل‌ها «رها شد» نشان می‌دهند
نقطه پایانی شما در هیچ‌یک از پنج تلاش به‌موقع نپذیرفت: در دسترس نبود، بیش از حد کند بود یا خطا برگرداند. آن را درست کنید؛ رویدادهای تازه وقتی پاسخ دهد تحویل می‌شوند.
صفحه نشانی من را رد می‌کند
CostGuard نتوانست از این نشانی استفاده کند. باید HTTPS، روی یک میزبان عمومی و روی یک درگاه استاندارد باشد. نشانی‌ای که نام کاربری یا گذرواژه در خود دارد هم رد می‌شود.
نمی‌توانم مقصد دیگری ثبت کنم
فضای کاری ده مقصد ثبت کرده که بیشترین شمار مجاز است. نخست مقصدی را که دیگر به کار نمی‌برید حذف کنید.