مستندسازی نود وبهوک#
استفاده از نود وبهوک برای ایجاد وبهوک‌ها، که می‌توانند هنگام وقوع ایونت، داده‌هایی از برنامه‌ها و سرویس‌ها دریافت کنند. این یک نود تریگر است، یعنی می‌تواند یک روند n98n را شروع کند. این امکان را می‌دهد که سرویس‌ها به n98n متصل شده و یک روند را اجرا کنند.
شما می‌توانید از نود وبهوک به عنوان تریگر برای یک روند زمانی که مایلید داده‌ای را دریافت کرده و بر اساس آن، روندی را اجرا کنید، استفاده کنید. نود وبهوک همچنین از بازگرداندن داده‌های تولید شده در انتهای یک روند پشتیبانی می‌کند. این آن را برای ساختن روندی جهت پردازش داده‌ها و بازگرداندن نتایج، مانند یک نقطه انتهای API مفید می‌سازد.
این وبهوک به شما امکان می‌دهد تا از سرویس‌هایی که دارای مرجع فعالسازی خاص نیستند، روندها را فعال کنید.
فرآیند توسعه روند#
n98n چندین آدرس URL برای وبهوک برای تست و تولید ارائه می‌دهد. آدرس URL تست شامل گزینه پوش شنیدن برای ایونت آزمایشی است. برای اطلاعات بیشتر در مورد ساخت، تست و انتقال نود وبهوک به حالت تولید، به توسعه روند مراجعه کنید.
پارامترهای نود#
از این پارامترها برای پیکربندی نود خود استفاده کنید.
آدرس‌های وبهوک#
نود وبهوک دو آدرس وبهوک دارد: تست و تولید. n98n این آدرس‌ها را در بالای پنل نود نمایش می‌دهد.
برای تغییر بین این دو، آدرس URL آزمایشی یا آدرس URL پروداکشن را انتخاب کنید.
- آزمایش: هنگام انتخاب پوش شنیدن برای ایونت آزمایشی یا اجرای روند، n98n یک وبهوک آزمایشی ثبت می‌کند، در صورتی که روند فعال نباشد. وقتی از آدرس وبهوک استفاده می‌کنید، n98n داده‌های روند را نشان می‌دهد.
- تولید: هنگام فعال کردن روند، n98n یک وبهوک پروداکشن ثبت می‌کند. در این حالت، داده‌ها در روند نمایش داده نمی‌شود. اما می‌توانید داده‌های اجرای روند پروداکشن را مشاهده کنید: به برگه اجرای‌ها در روند بروید و اجرای مورد نظر را انتخاب کنید.
روش‌های HTTP#
نود وبهوک از روش‌های درخواست HTTP استاندارد پشتیبانی می‌کند:
- DELETE
- GET
- HEAD
- PATCH
- POST
- PUT
حداکثر حجم محموله وبهوک
- حجم حداکثر محموله وبهوک ۱۶ مگابایت است.
- اگر n98n را بر روی سرور خود میزبانی می‌کنید، می‌توانید این مقدار را با استفاده از متغیر محیطی انتهای سرویس
N8N_PAYLOAD_SIZE_MAXتغییر دهید. ///
مسیر (Path)#
به‌طور پیش‌فرض، این فیلد شامل یک مسیر آدرس وبهوک تصادفی است، تا از تداخل با دیگر نودهای وبهوک جلوگیری شود.
می‌توانید مسیر URL را به صورت دستی وارد کنید، از جمله اضافه کردن پارامترهای مسیر. مثلا، اگر n98n را برای نمونه‌سازی API استفاده می‌کنید و به آدرس‌های endpoint ثابت نیاز دارید، این کار لازم است.
فرمت‌های قابل قبول برای فیلد مسیر عبارتند از:
/:متغیر/مسیر/:متغیر/:متغیر/مسیر/:متغیر1/مسیر/:متغیر2/:متغیر1/:متغیر2
روش‌های احراز هویت پشتیبانی شده#
می‌توانید نیاز به احراز هویت برای هر سرویس فراخوانی‌کننده آدرس وبهوک تنظیم کنید. این روش‌ها شامل موارد زیر است:
- احراز هویت پایه (Basic auth)
- احراز هویت در هدر (Header auth)
- احراز هویت JWT
- بدون احراز هویت
برای اطلاعات بیشتر در مورد پیکربندی هر نوع اعتبارنامه، به اعتبارنامه‌های وبهوک مراجعه کنید.
پاسخ‌دهی (Respond)#
- فورا: نود وبهوک کد پاسخ و پیام روند شروع شد را برمی‌گرداند.
- وقتی آخرین نود تمام شد: نود وبهوک کد پاسخ و خروجی داده‌های آخرین نود اجرا شده در روند را برمی‌گرداند.
- با استفاده از نود 'پاسخ به وبهوک': نود وبهوک به شکل تعیین شده در نود پاسخ به وبهوک پاسخ می‌دهد.
کد پاسخ (Response Code)#
می‌توانید کد پاسخ HTTP که هنگام اجرای موفق، توسط نود وبهوک برگردانده می‌شود، سفارشی کنید. از کدهای رایج یا کد دلخواه خود استفاده کنید.
داده‌های پاسخ (Response Data)#
می‌توانید نوع داده‌هایی را که در بدنه پاسخ قرار می‌گیرد، انتخاب کنید:
- همه ورودی‌ها: وبهوک تمامی ورودی‌های آخرین نود را در قالب آرایه برمی‌گرداند.
- ورود JSON اول: وبهوک داده JSON اولین ورودی آخرین نود را در یک شی JSON برمی‌گرداند.
- ورود باینری اول: وبهوک داده باینری اولین ورودی آخرین نود را در یک فایل باینری برمی‌گرداند.
- بدنه پاسخ ندارد: وبهوک بدون بدنه پاسخ می‌دهد.
این تنظیمات تنها در حالت پاسخ > زمانی که آخرین نود تمام شد برقرار است.
گزینه‌های نود#
برای مشاهده گزینه‌های پیکربندی بیشتر، افزودن گزینه را انتخاب کنید. گزینه‌های موجود بستگی به پارامترهای نود شما دارد. برای جزئیات، به جدول موجود مراجعه کنید.
- مبداهای مجاز (CORS): دامنه‌های مجاز برای درخواست‌های میان‌مبدا غیرپیش‌پروتکل را تنظیم کنید. لیستی از آدرس‌های اینترنتی جدا شده با کاما وارد کنید. برای مجاز کردن همه مبدأها،
*(پیش‌فرض) را وارد کنید. - خصوصیت باینری: فعال کردن این تنظیم، به نود وبهوک اجازه می‌دهد داده‌های باینری، مانند تصویر یا فایل صوتی، دریافت کند. نام خصوصیت باینری را وارد کنید تا داده فایل دریافتی نوشته شود.
- صرف‌نظر کردن از ربات‌ها: درخواست‌های ربات‌ها مانند پیش‌نمایش لینک و خزنده‌های وب را نادیده بگیرید.
- لیست سفید IPها: با فعال کردن این گزینه، مشخص کنید چه کسانی (یا چه چیزهایی) می‌توانند از URL فعالسازی وبهوک استفاده کنند. لیستی از آی‌پی‌های مجاز، جدا شده با کاما، وارد کنید. دسترسی از آی‌پی‌های خارج از لیست سفید، خطای ۴۰۳ برمی‌گرداند. اگر خالی باشد، همه آی‌پی‌ها می‌توانند از URL فعالسازی استفاده کنند.
- بدنه پاسخ نباشد: فعال کنید تا n98n پاسخ بدون بدن ارسال کند.
- بدن خام: مشخص کنید که نود وبهوک داده‌ها را به صورت خام، مانند JSON یا XML، دریافت کند.
- نوع محتوای پاسخ (Response Content-Type): قالب بدنه وبهوک را انتخاب کنید.
- داده‌های پاسخ: داده‌های سفارشی را همراه با پاسخ ارسال کنید.
- هدرهای پاسخ: هدرهای اضافی در پاسخ وبهوک ارسال کنید. برای بیشتر بدانید، به مستندات MDN | هدر پاسخ مراجعه کنید.
- نام خاصیت (Property Name): به‌طور پیش‌فرض، n98n تمام داده‌های موجود را برمی‌گرداند. می‌توانید کلید JSON خاصی را انتخاب کنید، تا مقدار آن برگردانده شود.
| گزینه | پیکربندی مورد نیاز نود |
|---|---|
| مبداهای مجاز (CORS) | هر مورد |
| خصوصیت باینری | هر مورد، در هنگام: روش HTTP > POST روش HTTP > PATCH روش HTTP > PUT |
| صرف‌نظر کردن از ربات‌ها | هر مورد |
| لیست IPها | هر مورد |
| نام خاصیت | هر دو: پاسخ > هنگامی که آخرین نود تمام شد داده‌های پاسخ > اولین ورودی JSON |
| بدون بدنه پاسخ | پاسخ > فورا |
| بدن خام | هر مورد |
| کد پاسخ | هر مورد به جز پاسخ‌گویی از طریق 'پاسخ به وبهوک' |
| نوع محتوا پاسخ | هر دو: پاسخ > هنگامی که آخرین نود تمام شد داده‌های پاسخ > اولین ورودی JSON |
| داده‌های پاسخ | پاسخ > فورا |
| هدرهای پاسخ | هر مورد |
قالب‌ها و نمونه‌ها#
مشکلات رایج#
برای سوالات یا مشکلات متداول و راه‌حل‌های پیشنهادی، به مشکلات رایج مراجعه کنید.