Notification handlers

Retrieve all

GET https://virt.cards/api/notification-handlers/
curl --request GET \
--url 'https://virt.cards/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "[email protected]"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2025-09-13 18:09:01",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://virt.cards/api/notification-handlers?page=1",
        "last": "https://virt.cards/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://virt.cards/api/notification-handlers?page=1"
    }
}

Retrieve one

GET https://virt.cards/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://virt.cards/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": "2025-09-13 18:09:01",
    }
}

Create

POST https://virt.cards/api/notification-handlers
Parameters Details Description
name Required String -
type Required String Allowed values: email , webhook , slack , discord , telegram , microsoft_teams
email Optional String Available when: type = email Email
webhook Optional String Available when: type = webhook Webhook URL
slack Optional String Available when: type = slack Slack webhook URL
discord Optional String Available when: type = discord Discord webhook URL
telegram Optional String Available when: type = telegram Telegram API Token
telegram_chat_id Optional String Available when: type = telegram Telegram Chat ID
microsoft_teams Optional String Available when: type = microsoft_teams Microsoft Teams webhook URL
curl --request POST \
--url 'https://virt.cards/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
    }
}

Update

POST https://virt.cards/api/notification-handlers/{notification_handler_id}
Parameters Details Description
name Optional String -
type Optional String Allowed values: email , webhook , slack , discord , telegram , microsoft_teams
email Optional String Available when: type = email Email
webhook Optional String Available when: type = webhook Webhook URL
slack Optional String Available when: type = slack Slack webhook URL
discord Optional String Available when: type = discord Discord webhook URL
telegram Optional String Available when: type = telegram Telegram API Token
telegram_chat_id Optional String Available when: type = telegram Telegram Chat ID
microsoft_teams Optional String Available when: type = microsoft_teams Microsoft Teams webhook URL
is_enabled Optional Boolean -
curl --request POST \
--url 'https://virt.cards/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

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