الخطافات (Webhooks) هي طريقة يمكن للتطبيقات من خلالها إرسال رسائل أو معلومات تلقائية إلى خدمات أخرى.
هذه هي الطريقة التي يستخدمها Workiom لإعلام تطبيق المحاسبة الخاص بك عند جاهزية الفاتورة، أو كيف يمكنك إرسال إشعار على Slack عند إضافة سجل ملاحظات من خلال النماذج.
هناك بعض واجهات البرمجة في Workiom لاستخدامها للخطافات.
الموارد:
نقطة نهاية واجهة البرمجة متاحة على الرابط https://api.workiom.com.
مثال كامل حول كيفية دمج واجهة برمجة التطبيقات لـ Workiom مع Pabbly Workflow.
نوع الحدث:
ضبط: نوع الحدث: 0؛ (عند إنشاء سجل)نوع الحدث: 1؛ (عند تحديث السجل)
مثال:
curl -X POST "https://api.workiom.com/api/services/app/WebhookSubscription/AddSubscription" -H "accept: text/plain" -H "Content-Type: application/json-patch+json" -H "X-API-KEY={UP6tlj+kHsBCgkUcK/2xd1dB7NACAf64UU1WNsn7niYTjILq29+7/7h5rrAl1zyNGoO3uI1O8MeibOThuy5gk8gmMIVd308n1UhVQXWlGLg=}" -d "{ "appId":"{يمكنك العثور عليه من رابط المستأجر الخاص بك}", "listId":"{يمكنك العثور عليه من رابط المستأأجر الخاص بك}", "name":"{أعطِ اسمًا}", "isActive":true, "webHook":"{عنوان URL سيتم تشغيله}", "eventType":0, "id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}"
2. الحصول على جميع الاشتراكات
​/api​/services​/app​/WebhookSubscription​/GetAllSubscriptions
مثال:
curl -X GET "https://api.workiom.com/api/services/app/WebhookSubscription/GetAllSubscriptions" -H "accept: text/plain" -H "X-API-KEY={Your API Key}"
للحصول على جميع الاشتراكات التي تم تكوينها بالفعل في المستأجر الخاص بك مع حسابك.
3. الحصول على الاشتراك
​/api​/services​/app​/WebhookSubscription​/GetSubscription
مثال:
curl -X GET "http://api.workiom.club:7777/api/services/app/WebhookSubscription/GetSubscription?subscriptionId=(your subscriptionId)" -H "accept: text/plain" -H "X-API-KEY={Your API Key}"
للحصول على الاشتراك الذي تم تكوينه بالفعل في المستأجر الخاص بك مع حسابك.
4. حذف الاشتراك
/api/services/app/WebhookSubscription/DeleteSubscription
مثال:
curl -X DELETE "http://api.workiom.com/api/services/app/WebhookSubscription/DeleteSubscription?subscriptionId=(Your Subscription Id)" -H "accept: */*" -H "X-API-KEY={Your API Key}"
لحذف الاشتراك من المستأجر الخاص بك مع حسابك.
5. تحديث الاشتراك
/api/services/app/WebhookSubscription/UpdateSubscription
مثال:
curl -X PUT "http://api.workiom.com/api/services/app/WebhookSubscription/UpdateSubscription" -H "accept: */*" -H "Content-Type: application/json-patch+json" -H "X-API-KEY={Your API Key}" -d "{"appId\":\"Your App Id\","listId\":\"Your List Id\","name\":\"Use a name\","isActive\":true,"webHook\":\"The URL that will be triggered","eventType\":1,"id\":\"Subscription Id"}"
لتحديث الاشتراك الذي تم تكوينه بالفعل في المستأجر الخاص بك مع حسابك.