Перейти к содержимому
/
Update NATS notification...

Vilna API (1.0.0)

Добро пожаловать в справочник Vilna API. Это полная спецификация OpenAPI для всех endpoints API.

Быстрые ссылки

API Endpoints

Управление активами

  • Активы - Обнаружение и управление цифровыми активами

Операции с адресами

Мониторинг и уведомления

Система

Нужна помощь?

Посетите наш портал документации для подробных руководств и примеров.

Скачать описание OpenAPI
spec.json
spec.yaml
Обзор
URL
https://vilna.io
Vilna API Team
[email protected]
Лицензия
Apache 2.0
Условия предоставления услуг
Языки
Серверы
Mock server
https://docs.vilna.io/_mock/ru/apis/spec/
Production environment
https://{namespace}.vilna.app/{version}/

system

System and service status operations

Операции

blockchain

Operations related to supported blockchains for monitoring and balance queries

Операции

block

Operations for retrieving and filtering blockchain blocks

Операции

token

Manage blockchain tokens such as native and ERC-20 assets

Операции

public_key

Public key (BIP44/49/84) management operations for HD wallets

Операции

address

Address management operations for tracking blockchain addresses

Операции

notification_channel

Notification delivery channel management for alerts and event notifications

Операции

Get list of notification channels

Запрос

Returns a paginated list of all notification delivery channels

Безопасность
ApiKeyAuth
Запрос
limitinteger[ 1 .. 100 ]

Maximum number of items to return

По умолчанию 20
Пример: limit=20
pageinteger>= 1

Page number for pagination

По умолчанию 1
Пример: page=1
kindstring(NotificationChannelKind)

Filter notification channels by their delivery type.

When specified, only channels of the given type will be returned:

  • nats — NATS subject-based messaging channels
  • telegram — Telegram bot message delivery channels
  • webhook — HTTP webhook callback channels
Перечисление"nats""telegram""webhook"
Пример: kind=webhook
is_archivedboolean

Filter notification channels by their archived status.

  • true — Returns only archived (disabled) channels
  • false — Returns only active (enabled) channels
  • Omit parameter — Returns both active and archived channels

Archived channels are temporarily disabled but retain their configuration for potential reactivation later.

searchstring[ 1 .. 128 ] characters

Search notification channels by name using case-insensitive pattern matching.

The search is performed on the channel name field using SQL ILIKE pattern matching:

  • Partial matches are supported
  • Case-insensitive search
  • Whitespace is normalized

Examples:

  • "webhook" — matches channels with "webhook" in the name
  • "prod" — matches "Production Alerts", "prod-monitoring", etc.
  • "alert" — matches "System Alerts", "Critical Alert Channel", etc.
Пример: search=production
sort_bystring

Field to sort results by. Use "-" prefix for descending order

По умолчанию "-created_at"
Перечисление"name""-name""kind""-kind""created_at""-created_at""updated_at""-updated_at"
Пример: sort_by=name
curl -i -X GET \
  'https://docs.vilna.io/_mock/ru/apis/spec/notification_channels?limit=20&page=1&kind=webhook&is_archived=true&search=production&sort_by=name' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

List of notification channels with pagination

Телоapplication/json
itemsArray of objects(NotificationChannel)обязательный
items[].​idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
items[].​kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
items[].​namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
items[].​configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
items[].​config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
items[].​config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
items[].​is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
items[].​created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
items[].​updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
metaobject(PaginationMeta)обязательный
meta.​limitinteger(uint)>= 1обязательный

Number of items per page

Пример: 20
meta.​pageinteger(uint)>= 1обязательный

Current page number

Пример: 1
meta.​totalinteger(uint)>= 0обязательный

Total number of items available

Пример: 42
meta.​total_pagesinteger(uint)>= 0обязательный

Total number of pages available

Пример: 3
Ответ
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ],
  "meta": {
    "page": 1,
    "limit": 30,
    "total": 15,
    "total_pages": 1
  }
}

Create NATS notification channel

Запрос

Creates a new NATS notification channel for subject-based messaging

Безопасность
ApiKeyAuth
Телоapplication/jsonобязательный
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/nats \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "System Alerts NATS",
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update NATS notification channel

Запрос

Update the configuration of an existing NATS notification channel

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
Телоapplication/jsonобязательный
non-empty
namestring(NotificationChannelName)[ 1 .. 255 ] characters

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
urlstring(uri)(NATSServerURL)

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
subjectstring(NATSSubject)[ 1 .. 255 ] characters

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
curl -i -X PATCH \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/nats/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Updated NATS Channel"
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Create Telegram notification channel

Запрос

Creates a new Telegram notification channel for bot message delivery

Безопасность
ApiKeyAuth
Телоapplication/jsonобязательный
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
bot_tokenstring(TelegramBotToken)^\d{7,12}:[A-Za-z0-9_-]{35}$обязательный

Telegram Bot API token obtained from @BotFather.

Format: {bot_id}:{auth_token} Example: "123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"

Security Note: This is sensitive data and should be handled securely. In some API responses, this may be masked or omitted.

Пример: "123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789"
chat_idinteger(int64)(TelegramChatID)обязательный

Telegram chat ID where notifications will be sent.

Chat ID formats:

  • Private chats (positive numbers)
  • Group chats (negative numbers)
  • Channel chats (negative numbers starting with -100)

You can obtain chat IDs by:

  • Adding the bot to a chat and using /start command
  • Using Telegram Bot API methods like getUpdates
  • Using @userinfobot for user/chat information
Пример: -1001234567890
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/telegram \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Production Alerts",
    "bot_token": "987654321:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789",
    "chat_id": -1001234567890
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update Telegram notification channel

Запрос

Update the configuration of an existing Telegram notification channel

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
Телоapplication/jsonобязательный
non-empty
namestring(NotificationChannelName)[ 1 .. 255 ] characters

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
bot_tokenstring(TelegramBotToken)^\d{7,12}:[A-Za-z0-9_-]{35}$

Telegram Bot API token obtained from @BotFather.

Format: {bot_id}:{auth_token} Example: "123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"

Security Note: This is sensitive data and should be handled securely. In some API responses, this may be masked or omitted.

Пример: "123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789"
chat_idinteger(int64)(TelegramChatID)

Telegram chat ID where notifications will be sent.

Chat ID formats:

  • Private chats (positive numbers)
  • Group chats (negative numbers)
  • Channel chats (negative numbers starting with -100)

You can obtain chat IDs by:

  • Adding the bot to a chat and using /start command
  • Using Telegram Bot API methods like getUpdates
  • Using @userinfobot for user/chat information
Пример: -1001234567890
curl -i -X PATCH \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/telegram/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Updated Telegram Channel"
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Create Webhook notification channel

Запрос

Creates a new Webhook notification channel for HTTP callback delivery

Безопасность
ApiKeyAuth
Телоapplication/jsonобязательный
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
urlstring(uri)(WebhookURL)обязательный

HTTP/HTTPS URL endpoint where notification webhooks will be sent.

The URL must be accessible from the notification service and should accept POST requests with JSON payloads. Only HTTP and HTTPS protocols are supported for security reasons.

Security Note: URLs containing sensitive information (API keys in query params) should use headers for authentication instead.

Пример: "https://api.example.com/webhooks/notifications"
headersobject(WebhookHeaders)обязательный

Optional HTTP headers to include with webhook requests.

Commonly used for:

  • Authentication: "Authorization: Bearer token"
  • Content type: "Content-Type: application/json"
  • API keys: "X-API-Key: your-api-key"
  • Custom headers for routing or identification

Security Note: Sensitive headers (tokens, API keys) should be handled securely and may be masked in API responses.

Пример: {"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","Content-Type":"application/json","X-API-Key":"your-secret-api-key"}
headers.​property name*stringдополнительное свойство
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/webhook \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Production Alerts Webhook",
    "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    "headers": {
      "Authorization": "Bearer token123"
    }
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update Webhook notification channel

Запрос

Update the configuration of an existing Webhook notification channel

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
Телоapplication/jsonобязательный
non-empty
namestring(NotificationChannelName)[ 1 .. 255 ] characters

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
urlstring(uri)(WebhookURL)

HTTP/HTTPS URL endpoint where notification webhooks will be sent.

The URL must be accessible from the notification service and should accept POST requests with JSON payloads. Only HTTP and HTTPS protocols are supported for security reasons.

Security Note: URLs containing sensitive information (API keys in query params) should use headers for authentication instead.

Пример: "https://api.example.com/webhooks/notifications"
headersobject(WebhookHeaders)

Optional HTTP headers to include with webhook requests.

Commonly used for:

  • Authentication: "Authorization: Bearer token"
  • Content type: "Content-Type: application/json"
  • API keys: "X-API-Key: your-api-key"
  • Custom headers for routing or identification

Security Note: Sensitive headers (tokens, API keys) should be handled securely and may be masked in API responses.

Пример: {"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","Content-Type":"application/json","X-API-Key":"your-secret-api-key"}
curl -i -X PATCH \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/webhook/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Updated Webhook Channel"
  }'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Get notification channel by ID

Запрос

Returns detailed information about a specific notification channel

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/550e8400-e29b-41d4-a716-446655440000 \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

Notification channel details

Телоapplication/json
idstring(uuid)(UUID)обязательный

Unique identifier in UUID format

Пример: "550e8400-e29b-41d4-a716-446655440000"
kindstring(NotificationChannelKind)обязательный

Defines the type of notification delivery channel.

Each kind determines the transport mechanism and configuration structure:

  • nats — NATS subject-based messaging for internal microservice communication
  • telegram — Telegram bot message delivery to chats or direct messages
  • webhook — HTTP POST callbacks to external endpoints
Перечисление"nats""telegram""webhook"
Пример: "webhook"
namestring(NotificationChannelName)[ 1 .. 255 ] charactersобязательный

User-defined human-readable name for the notification channel.

Used to identify and distinguish between different notification channels. The name should be descriptive and help users understand the purpose or destination of the channel.

Пример: "Production Alerts Webhook"
configNATSChannelConfig (object) or TelegramChannelConfig (object) or WebhookChannelConfig (object)(NotificationChannelConfig)обязательный

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
One of:

Configuration structure for notification channels. The exact schema depends on the channel kind.

Each channel type has specific configuration requirements:

  • NATS channels require a subject for message routing
  • Telegram channels require bot token and chat ID for message delivery
  • Webhook channels require URL and optional headers/authentication
config.​urlstring(uri)(NATSServerURL)обязательный

NATS server URL for connection.

Specifies the NATS server endpoint where notifications will be published. Supports various NATS URL formats:

  • nats://localhost:4222 - Standard NATS connection
  • nats://user:[email protected]:4222 - With authentication

Security Note: URLs containing credentials should be handled securely and may be masked in API responses.

Пример: "nats://nats.example.com:4222"
config.​subjectstring(NATSSubject)[ 1 .. 255 ] charactersобязательный

NATS subject (topic) where notifications will be published.

Subjects are hierarchical and use dot notation (e.g., "notifications.alerts.critical"). Wildcards can be used for subscription patterns:

  • * matches any single token
  • > matches any number of tokens at the end

Examples:

  • "notifications.system.alerts"
  • "events.user.created"
  • "monitoring.metrics.cpu"
Пример: "notifications.webhooks.delivery"
is_archivedbooleanобязательный

Indicates whether the notification channel is archived (disabled)

Пример: false
created_atstring(date-time)(CreatedAt)обязательный

Timestamp when the resource was created

Пример: "2024-01-15T10:30:00Z"
updated_atstring(date-time)(UpdatedAt)обязательный

Timestamp when the resource was last updated

Пример: "2024-01-15T10:30:00Z"
Ответ
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "nats",
  "name": "System Alerts NATS",
  "config": {
    "url": "nats://nats.example.com:4222",
    "subject": "notifications.system.alerts"
  },
  "is_archived": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Delete notification channel

Запрос

Delete a notification channel by its unique identifier

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
curl -i -X DELETE \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/550e8400-e29b-41d4-a716-446655440000 \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

The request was successful but there is no content to return

Ответ
Нет содержимого

Archive notification channel

Запрос

Archives (disables) a notification channel while preserving its configuration

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/550e8400-e29b-41d4-a716-446655440000/actions/archive \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

The request was successful but there is no content to return

Ответ
Нет содержимого

Restore notification channel

Запрос

Restores an archived notification channel, making it active again

Безопасность
ApiKeyAuth
Путь
notification_channel_idstring(uuid)(UUID)обязательный

Unique identifier (UUID) of the notification channel.

Пример: 550e8400-e29b-41d4-a716-446655440000
curl -i -X POST \
  https://docs.vilna.io/_mock/ru/apis/spec/notification_channels/550e8400-e29b-41d4-a716-446655440000/actions/restore \
  -H 'X-Api-Key: YOUR_API_KEY_HERE'

Ответы

The request was successful but there is no content to return

Ответ
Нет содержимого

transaction

Blockchain transaction tracking and monitoring operations

Операции

simulate

Transaction simulation operations for various blockchain networks

asset

Asset management operations for blockchain assets

Операции