Skip to content

اندپوینت ثبت Webhook

اندپوینت REST API برای ثبت و اشتراک در webhookها در WSMS.

این اندپوینت به شما امکان می‌دهد webhookها را در WSMS ثبت و مشترک شوید. از آن برای دریافت به‌روزرسانی یا اعلان‌ها هنگام وقوع رویدادهای خاص استفاده کنید.

اندپوینت

POST /wp-json/wpsms/v1/webhook

احراز هویت

WSMS از احراز هویت با رمز عبور برنامه‌ای (وردپرس 5.6 به بالا) پشتیبانی می‌کند.

ایجاد رمز عبور برنامه‌ای

  1. در پیشخوان وردپرس به کاربران ← نمایه بروید
  2. به بخش رمزهای عبور برنامه‌ای اسکرول کنید
  3. در فیلد نام رمز عبور برنامه‌ای جدید یک نام وارد کنید
  4. روی افزودن رمز عبور برنامه‌ای جدید کلیک کنید
  5. رمز عبور تولید شده را کپی کنید

از نام کاربری یا ایمیل وردپرس خود به عنوان نام کاربری همراه با رمز عبور برنامه‌ای استفاده کنید.

پارامترهای درخواست

پارامترنوعالزامیتوضیحات
webhook_urlstringبلهآدرس URL برای دریافت اعلان‌های webhook
typestringبلهنوع رویداد: new_subscriber یا new_sms

انواع رویداد

نوعتوضیحات
new_subscriberهنگام عضویت مشترک جدید فعال می‌شود
new_smsهنگام دریافت SMS جدید فعال می‌شود

نمونه‌ها

cURL

curl --location --request POST 'https://site.com/wp-json/wpsms/v1/webhook' \
--header 'Authorization: Basic YOUR_API_KEY' \
--form 'webhook_url="https://your-webhook-url.com"' \
--form 'type="new_sms"'

PHP

<?php
$username = 'your-username';
$password = 'your-application-password';
$auth = base64_encode("$username:$password");

$url = 'https://site.com/wp-json/wpsms/v1/webhook';

$args = array(
    'headers' => array(
        'Authorization' => 'Basic ' . $auth,
    ),
    'body' => array(
        'webhook_url' => 'https://your-webhook-url.com',
        'type' => 'new_sms',
    ),
);

$response = wp_remote_post($url, $args);

موارد استفاده

  • یکپارچه‌سازی با Zapier یا سایر ابزارهای اتوماسیون
  • همگام‌سازی مشترکین جدید با CRM خارجی
  • ثبت پیامک‌های دریافتی در سیستم‌های خارجی
  • راه‌اندازی فرآیندهای کاری سفارشی بر اساس رویدادهای خاص

مرتبط

آخرین به‌روزرسانی: ۳ دی ۱۴۰۳