Notification handlers
GET https://z-bio.link/api/notification-handlers/
curl --request GET \
--url 'https://z-bio.link/api/notification-handlers/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--url 'https://z-bio.link/api/notification-handlers/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| search | اختياري نص | نص البحث. |
| search_by | اختياري نص | الحقل الذي تبحث فيه. القيم المسموح بها هي: name. |
| is_enabled | اختياري قيمة منطقية | |
| type | اختياري نص | الحقل الذي تبحث فيه. القيم المسموح بها هي: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification. |
| datetime_field | اختياري نص | القيم المسموح بها: datetime, last_datetime |
| datetime_start | اختياري نص | Filter results starting from this datetime. Y-m-d H:i:s format. |
| datetime_end | اختياري نص | Filter results up to this datetime. Y-m-d H:i:s format. |
| order_by | اختياري نص | الحقل الذي ترتب النتائج به. القيم المسموح بها هي: notification_handler_id, datetime, last_datetime, name. |
| order_type | اختياري نص | ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي، و DESC للترتيب التنازلي. |
| search | اختياري نص | نص البحث. |
| search_by | اختياري نص | الحقل الذي تبحث فيه. القيم المسموح بها هي: name. |
| is_enabled | اختياري قيمة منطقية | |
| type | اختياري نص | الحقل الذي تبحث فيه. القيم المسموح بها هي: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification. |
| datetime_field | اختياري نص | القيم المسموح بها: datetime, last_datetime |
| datetime_start | اختياري نص | Filter results starting from this datetime. Y-m-d H:i:s format. |
| datetime_end | اختياري نص | Filter results up to this datetime. Y-m-d H:i:s format. |
| order_by | اختياري نص | الحقل الذي ترتب النتائج به. القيم المسموح بها هي: notification_handler_id, datetime, last_datetime, name. |
| order_type | اختياري نص | ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي، و DESC للترتيب التنازلي. |
| page | اختياري عدد صحيح | رقم الصفحة التي تريد النتائج منها. الافتراضي هو 1. |
| results_per_page | اختياري عدد صحيح | عدد النتائج التي تريدها في كل صفحة. القيم المسموح بها هي: 10, 25, 50, 100, 250, 500, 1000. الافتراضي هو 25. |
{
"data": [
{
"id": 1,
"user_id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": 1,
"last_datetime": null,
"datetime": "2026-11-22 12:45:40"
}
],
"meta": {
"page": 1,
"total_pages": 1,
"results_per_page": 25,
"total_results": 1
},
"links": {
"first": "https://z-bio.link/api/notification-handlers?page=1",
"last": "https://z-bio.link/api/notification-handlers?page=1",
"next": null,
"prev": null,
"self": "https://z-bio.link/api/notification-handlers?page=1"
}
}
GET https://z-bio.link/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
{
"data": {
"id": 1,
"user_id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": 1,
"last_datetime": null,
"datetime": "2026-11-22 12:45:40"
}
}
POST https://z-bio.link/api/notification-handlers
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| name | مطلوب نص | - |
| type | مطلوب نص | القيم المسموح بها: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification |
| اختياري نص | متاح عندما: type = email Email | |
| webhook | اختياري نص | متاح عندما: type = webhook Webhook URL |
| slack | اختياري نص | متاح عندما: type = slack Slack webhook URL |
| discord | اختياري نص | متاح عندما: type = discord Discord webhook URL |
| telegram | اختياري نص | متاح عندما: type = telegram Telegram API Token |
| telegram_chat_id | اختياري نص | متاح عندما: type = telegram Telegram Chat ID |
| microsoft_teams | اختياري نص | متاح عندما: type = microsoft_teams Microsoft Teams webhook URL |
| google_chat | اختياري نص | متاح عندما: type = google_chat Google Chat webhook URL |
| x_consumer_key | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_consumer_secret | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_access_token | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_access_token_secret | اختياري نص | متاح عندما: type = x Telegram API Token |
| twilio | اختياري نص | متاح عندما: type = twilio Phone number |
| twilio_call | اختياري نص | متاح عندما: type = twilio_call Phone number |
| اختياري نص | متاح عندما: type = whatsapp Phone number |
curl --request POST \
--url 'https://z-bio.link/api/notification-handlers' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
--url 'https://z-bio.link/api/notification-handlers' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
"data": {
"id": 1,
"user_id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hello@example.com"
},
"is_enabled": 1,
"last_datetime": null,
"datetime": "2026-11-22 12:45:40"
}
}
POST https://z-bio.link/api/notification-handlers/{notification_handler_id}
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| name | اختياري نص | - |
| type | اختياري نص | القيم المسموح بها: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call, whatsapp, x, google_chat, internal_notification |
| اختياري نص | متاح عندما: type = email Email | |
| webhook | اختياري نص | متاح عندما: type = webhook Webhook URL |
| slack | اختياري نص | متاح عندما: type = slack Slack webhook URL |
| discord | اختياري نص | متاح عندما: type = discord Discord webhook URL |
| telegram | اختياري نص | متاح عندما: type = telegram Telegram API Token |
| telegram_chat_id | اختياري نص | متاح عندما: type = telegram Telegram Chat ID |
| microsoft_teams | اختياري نص | متاح عندما: type = microsoft_teams Microsoft Teams webhook URL |
| google_chat | اختياري نص | متاح عندما: type = google_chat Google Chat webhook URL |
| x_consumer_key | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_consumer_secret | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_access_token | اختياري نص | متاح عندما: type = x Telegram API Token |
| x_access_token_secret | اختياري نص | متاح عندما: type = x Telegram API Token |
| twilio | اختياري نص | متاح عندما: type = twilio Phone number |
| twilio_call | اختياري نص | متاح عندما: type = twilio_call Phone number |
| اختياري نص | متاح عندما: type = whatsapp Phone number | |
| is_enabled | اختياري قيمة منطقية | - |
curl --request POST \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
"data": {
"id": 1,
"user_id": 1,
"type": "email",
"name": "Example new name",
"settings": {
"email": "hello@example.com"
},
"is_enabled": 1,
"last_datetime": "2026-11-22 12:45:40",
"datetime": "2026-11-22 12:45:40"
}
}
DELETE https://z-bio.link/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--url 'https://z-bio.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \