通知处理程序
GET https://birbshare.com/api/notification-handler/
curl --request GET \
--url 'https://birbshare.com/api/notification-handler/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handler/' \
--header 'Authorization: Bearer {api_key}' \
| 参数 | Details | Description |
|---|---|---|
| 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": "2021-06-27 22:16:23"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://birbshare.com/api/notification-handler?&page=1",
"last": "https://birbshare.com/api/notification-handler?&page=1",
"next": null,
"prev": null,
"self": "https://birbshare.com/api/notification-handler?&page=1"
}
}
GET https://birbshare.com/api/notification-handler/{notification_handler_id}
curl --request GET \
--url 'https://birbshare.com/api/notification-handler/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handler/{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": "2021-06-27 22:16:23"
}
}
POST https://birbshare.com/api/notification-handlers
| 参数 | Details | Description |
|---|---|---|
| name | 需要的 字符串 | - |
| type | 需要的 字符串 | 允许的值：email , webhook , slack , discord , telegram , microsoft_teams |
| 可选的 字符串 | Available when: type = email 电子邮件 | |
| webhook | 可选的 字符串 | Available when: type = webhook Webhook URL |
| slack | 可选的 字符串 | Available when: type = slack Slack webhook URL |
| discord | 可选的 字符串 | Available when: type = discord Discord webhook URL |
| telegram | 可选的 字符串 | Available when: type = telegram Telegram API Token 电报 API 令牌 |
| telegram_chat_id | 可选的 字符串 | Available when: type = telegram Telegram 聊天 ID |
curl --request POST \
--url 'https://birbshare.com/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://birbshare.com/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://birbshare.com/api/notification-handlers/{notification_handler_id}
| 参数 | Details | Description |
|---|---|---|
| name | 可选的 字符串 | - |
| type | 可选的 字符串 | 允许的值：email , webhook , slack , discord , telegram , microsoft_teams |
| 可选的 字符串 | Available when: type = email 电子邮件 | |
| webhook | 可选的 字符串 | Available when: type = webhook Webhook URL |
| slack | 可选的 字符串 | Available when: type = slack Slack webhook URL |
| discord | 可选的 字符串 | Available when: type = discord Discord webhook URL |
| telegram | 可选的 字符串 | Available when: type = telegram Telegram API Token 电报 API 令牌 |
| telegram_chat_id | 可选的 字符串 | Available when: type = telegram Telegram 聊天 ID |
| is_enabled | 可选的 布尔值 | - |
curl --request POST \
--url 'https://birbshare.com/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://birbshare.com/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://birbshare.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://birbshare.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \