تنظیم Custom Webhook در Postman

Custom webhook integration در Postman برای خودکارسازی ارتباط بین Postman و سرویس‌های دیگر استفاده می‌شود. این integration با قابلیت Webhooks در بخش ارسال request فرق دارد. با custom webhook می‌توانید notification بفرستید، فایل‌ها را sync کنید، داده جمع‌آوری کنید، collection را backup بگیرید یا نتیجه monitorها و activity feed تیم را به URL دلخواه بفرستید.

فعال کردن static IP support #

اگر network شما پشت firewall است و می‌خواهید collection backup به custom webhook روی custom domain کار کند، باید static IP پستمن را allowlist کنید.

US East: 3.212.102.200

بعد از allowlist کردن این IP، callهای custom webhook می‌توانند به network شما وصل شوند و webhook مطابق انتظار کار کند.

تنظیم custom webhook #

1. در Postman از sidebar روی Integrations کلیک کنید و Browse All Integrations را باز کنید.
2. در لیست integrationها، Webhooks را search و انتخاب کنید.
3. کنار نوع webhook مورد نظر روی Add Integration کلیک کنید.
4. فرم مربوط به همان نوع webhook را کامل کنید.

بعد از ساخته شدن integration، می‌توانید آن را کنار سایر active integrationهای تیم ببینید.

ارسال updateهای Collection به custom webhook #

برای backup یا ارسال updateهای یک Collection:

1. در صفحه Webhooks Integrations کنار Backup a collection روی Add Integration کلیک کنید.
2. در صفحه Add integration، یک Nickname وارد کنید.
3. workspace مربوط به collection را انتخاب کنید.
4. collection مورد نظر را انتخاب کنید.
5. URL مربوط به webhook payload را وارد کنید.
6. روی Add Integration کلیک کنید.

Postman به صورت دوره‌ای collection را بررسی می‌کند. اگر تغییری پیدا شود، تغییرات خودکار به custom webhook ارسال می‌شوند.

Schema مربوط به Backup a collection شامل یک object اصلی و فیلد collection است که اطلاعات collection را نگه می‌دارد.

ارسال monitor result به custom webhook #

Postman Monitorها collectionها را طبق schedule اجرا می‌کنند. با custom webhook می‌توانید نتیجه monitorها را به سرویس دیگری بفرستید.

1. در Webhooks Integrations کنار Post monitoring results روی Add Integration کلیک کنید.
2. Nickname را وارد کنید.
3. workspace شامل monitor را انتخاب کنید.
4. monitor مورد نظر را انتخاب کنید.
5. URL دریافت‌کننده webhook payload را وارد کنید.
6. یکی از گزینه‌های notification را انتخاب کنید: Notify for all completed monitor runs یا Notify for 3 failures and then first success.
7. روی Add Integration کلیک کنید.

هر بار monitor اجرا شود، نتیجه به webhook ارسال می‌شود. Schema نمونه monitor result شامل فیلدهایی مثل collection_name، collection_uid، environment_name، metrics، monitor_name، monitor_uid، user_id و user_name است. داخل metrics مقدارهایی مثل errors، failedTests، passedTests، requestCount، totalLatency و warnings قرار می‌گیرد.

ارسال team activity feed به custom webhook #

Activity feed تغییرات انجام‌شده روی collectionها و داخل team را نشان می‌دهد. برای ارسال آن به webhook:

1. در Webhooks Integrations کنار Post team activity روی Add Integration کلیک کنید.
2. Nickname را وارد کنید.
3. Webhook URL مقصد را وارد کنید.
4. روی Add Integration کلیک کنید.

Schema نمونه team activity شامل فیلدهایی مثل action، collection_name، collection_uid، message، model، model_name، model_uid، user_id و user_name است.

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.