Instale nosso aplicativo Clique no ícone no canto superior direito da barra de endereço.

manipuladores de notificação

Recuperar todos

GET https://biofy.ai/api/notification-handlers/
curl --request GET \
--url 'https://biofy.ai/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional Cadeia de caracteres A string de pesquisa.
search_by Opcional Cadeia de caracteres Por qual campo você está pesquisando. Os valores permitidos são: name.
is_enabled Opcional Boolean
type Opcional Cadeia de caracteres Por qual campo você está pesquisando. Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams, whatsapp, x.
datetime_field Opcional Cadeia de caracteres Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia de caracteres Filtrar resultados a partir desta data e hora. Y-m-d H:i:s formato.
datetime_end Opcional Cadeia de caracteres Filtrar resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia de caracteres Por qual campo ordenar os resultados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia de caracteres A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
search Opcional Cadeia de caracteres A string de pesquisa.
search_by Opcional Cadeia de caracteres Por qual campo você está pesquisando. Os valores permitidos são: name.
is_enabled Opcional Boolean
type Opcional Cadeia de caracteres Por qual campo você está pesquisando. Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams, whatsapp, x.
datetime_field Opcional Cadeia de caracteres Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadeia de caracteres Filtrar resultados a partir desta data e hora. Y-m-d H:i:s formato.
datetime_end Opcional Cadeia de caracteres Filtrar resultados até esta data e hora. Formato Y-m-d H:i:s.
order_by Opcional Cadeia de caracteres Por qual campo ordenar os resultados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name.
order_type Opcional Cadeia de caracteres A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página de onde você deseja obter os resultados. O valor padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "[email protected]"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-06-06 02:20:04",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://biofy.ai/api/notification-handlers?page=1",
        "last": "https://biofy.ai/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://biofy.ai/api/notification-handlers?page=1"
    }
}

Recuperar um

GET https://biofy.ai/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://biofy.ai/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-06-06 02:20:04",
    }
}

Criar

POST https://biofy.ai/api/notification-handlers
Parâmetros Detalhes Descrição
name Obrigatório Cadeia de caracteres -
type Obrigatório Cadeia de caracteres Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams, whatsapp, x
email Opcional Cadeia de caracteres Disponível quando: type = email notification_handlers.email
webhook Opcional Cadeia de caracteres Disponível quando: type = webhook notification_handlers.webhook
slack Opcional Cadeia de caracteres Disponível quando: type = slack notification_handlers.slack
discord Opcional Cadeia de caracteres Disponível quando: type = discord notification_handlers.discord
telegram Opcional Cadeia de caracteres Disponível quando: type = telegram notification_handlers.telegram
telegram_chat_id Opcional Cadeia de caracteres Disponível quando: type = telegram notification_handlers.telegram_chat_id
microsoft_teams Opcional Cadeia de caracteres Disponível quando: type = microsoft_teams notification_handlers.microsoft_teams
x_consumer_key Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_consumer_secret Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_access_token Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_access_token_secret Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
whatsapp Opcional Cadeia de caracteres Disponível quando: type = whatsapp notification_handlers.twilio
curl --request POST \
--url 'https://biofy.ai/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=[email protected]' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://biofy.ai/api/notification-handlers/{notification_handler_id}
Parâmetros Detalhes Descrição
name Opcional Cadeia de caracteres -
type Opcional Cadeia de caracteres Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams, whatsapp, x
email Opcional Cadeia de caracteres Disponível quando: type = email notification_handlers.email
webhook Opcional Cadeia de caracteres Disponível quando: type = webhook notification_handlers.webhook
slack Opcional Cadeia de caracteres Disponível quando: type = slack notification_handlers.slack
discord Opcional Cadeia de caracteres Disponível quando: type = discord notification_handlers.discord
telegram Opcional Cadeia de caracteres Disponível quando: type = telegram notification_handlers.telegram
telegram_chat_id Opcional Cadeia de caracteres Disponível quando: type = telegram notification_handlers.telegram_chat_id
microsoft_teams Opcional Cadeia de caracteres Disponível quando: type = microsoft_teams notification_handlers.microsoft_teams
x_consumer_key Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_consumer_secret Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_access_token Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
x_access_token_secret Opcional Cadeia de caracteres Disponível quando: type = x notification_handlers.telegram
whatsapp Opcional Cadeia de caracteres Disponível quando: type = whatsapp notification_handlers.twilio
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://biofy.ai/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
    }
}

Excluir

DELETE https://biofy.ai/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://biofy.ai/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \