Notification handlers
GET https://boof360.bio/api/notification-handlers/
curl --request GET \
--url 'https://boof360.bio/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها | جزئیات | توصیف |
---|---|---|
page | اختیاری عدد صحیح | شماره صفحهای که میخواهید نتایج از آن بازیابی شوند. به صورت پیشفرض روی 1 تنظیم شده است.
|
results_per_page | اختیاری عدد صحیح | تعداد نتایج مورد نظر در هر صفحه. مقادیر مجاز: 10 , 25 , 50 , 100 , 250 , 500 , 1000 . به صورت پیشفرض روی 25 تنظیم شده است.
|
{
"data": [
{
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2025-07-16 21:41:13"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://boof360.bio/api/notification-handlers?&page=1",
"last": "https://boof360.bio/api/notification-handlers?&page=1",
"next": null,
"prev": null,
"self": "https://boof360.bio/api/notification-handlers?&page=1"
}
}
GET https://boof360.bio/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2025-07-16 21:41:13"
}
}
POST https://boof360.bio/api/notification-handlers
پارامترها | جزئیات | توصیف |
---|---|---|
name | الزامی رشته | - |
type | الزامی رشته | مقادیر مجاز: email , webhook , slack , discord , telegram , microsoft_teams , 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 |
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 |
curl --request POST \
--url 'https://boof360.bio/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
--url 'https://boof360.bio/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
"data": {
"id": 1
}
}
POST https://boof360.bio/api/notification-handlers/{notification_handler_id}
پارامترها | جزئیات | توصیف |
---|---|---|
name | اختیاری رشته | - |
type | اختیاری رشته | مقادیر مجاز: email , webhook , slack , discord , telegram , microsoft_teams , 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 |
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 |
is_enabled | اختیاری بولیان | - |
curl --request POST \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
"data": {
"id": 1
}
}
DELETE https://boof360.bio/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \