### GET /verify/telegram/username/{username} Source: https://connhex.com/api/notifications/latest/api.json API endpoint for GET /verify/telegram/username/{username} ```markdown ### Parameters - **username** (string, path, required) ### Responses #### 200 - response Empty response body #### 404 - Username not available Username not available ### Example Usage ```bash curl -X GET "http://connhex-notifications.connhex/verify/telegram/username/{username}" ``` ``` -------------------------------- ### Schema: CreateNotificationPayloadDto Source: https://connhex.com/api/notifications/latest/api.json Schema definition for CreateNotificationPayloadDto ```markdown ## Schema: CreateNotificationPayloadDto Schema definition for CreateNotificationPayloadDto **Type:** object - **title** (string) (required): Subject / title of the notification. - **body** (string) (required): Main content of the notification. - **bodyFormat** (object): Controls how `body` is interpreted for email notifications. - `"text"` (default): plain text, wrapped in the built-in HTML email template. - `"html"`: `body` is treated as a complete HTML document and sent as-is. When set to `"html"`, the fields `preview`, `incipit`, `conclusion`, and `footer` are ignored. Has no effect on non-email channels (Telegram, SMS, FCM, etc.). - **preview** (string): Email preview text shown in the inbox before opening the message. Ignored when `bodyFormat` is `"html"`. - **incipit** (string): Opening text displayed before the main body. Ignored when `bodyFormat` is `"html"`. - **conclusion** (string): Closing text displayed after the main body. Ignored when `bodyFormat` is `"html"`. - **footer** (string): Footer text displayed at the bottom of the email. Ignored when `bodyFormat` is `"html"`. ``` -------------------------------- ### POST /notify Source: https://connhex.com/api/notifications/latest/api.json API endpoint for POST /notify ```markdown ### Request Body **Content-Type:** application/json - **userId** (string): User ID of the target Connhex user. In order to deliver the notification, `userId`, `target`, or `targets` must be specified. - **target** (string): Notification target: can be an email address, a phone number or a telegram account. (example: "admin@connhex.com") - **targets** (array (string)): Notification targets: an array of target addresses (emails, phone numbers, device tokens, etc.). In order to deliver the notification, `userId`, `target`, or `targets` must be specified. (example: ["admin@connhex.com","user@connhex.com"]) - **medium** (string (email|telegram|sms|slack|discord|fcm|msteams)) (required) ("email"|"telegram"|"sms"|"slack"|"discord"|"fcm"|"msteams") - **payload** (object) (required) - **title** (string) (required): Subject / title of the notification. - **body** (string) (required): Main content of the notification. - **bodyFormat** (object): Controls how `body` is interpreted for email notifications. - `"text"` (default): plain text, wrapped in the built-in HTML email template. - `"html"`: `body` is treated as a complete HTML document and sent as-is. When set to `"html"`, the fields `preview`, `incipit`, `conclusion`, and `footer` are ignored. Has no effect on non-email channels (Telegram, SMS, FCM, etc.). - **preview** (string): Email preview text shown in the inbox before opening the message. Ignored when `bodyFormat` is `"html"`. - **incipit** (string): Opening text displayed before the main body. Ignored when `bodyFormat` is `"html"`. - **conclusion** (string): Closing text displayed after the main body. Ignored when `bodyFormat` is `"html"`. - **footer** (string): Footer text displayed at the bottom of the email. Ignored when `bodyFormat` is `"html"`. - **attachments** (array (MemoryStoredFile)) Array items: **Content-Type:** multipart/form-data - **userId** (string): User ID of the target Connhex user. In order to deliver the notification, `userId`, `target`, or `targets` must be specified. - **target** (string): Notification target: can be an email address, a phone number or a telegram account. (example: "admin@connhex.com") - **targets** (array (string)): Notification targets: an array of target addresses (emails, phone numbers, device tokens, etc.). In order to deliver the notification, `userId`, `target`, or `targets` must be specified. (example: ["admin@connhex.com","user@connhex.com"]) - **medium** (string (email|telegram|sms|slack|discord|fcm|msteams)) (required) ("email"|"telegram"|"sms"|"slack"|"discord"|"fcm"|"msteams") - **payload** (object) (required) - **title** (string) (required): Subject / title of the notification. - **body** (string) (required): Main content of the notification. - **bodyFormat** (object): Controls how `body` is interpreted for email notifications. - `"text"` (default): plain text, wrapped in the built-in HTML email template. - `"html"`: `body` is treated as a complete HTML document and sent as-is. When set to `"html"`, the fields `preview`, `incipit`, `conclusion`, and `footer` are ignored. Has no effect on non-email channels (Telegram, SMS, FCM, etc.). - **preview** (string): Email preview text shown in the inbox before opening the message. Ignored when `bodyFormat` is `"html"`. - **incipit** (string): Opening text displayed before the main body. Ignored when `bodyFormat` is `"html"`. - **conclusion** (string): Closing text displayed after the main body. Ignored when `bodyFormat` is `"html"`. - **footer** (string): Footer text displayed at the bottom of the email. Ignored when `bodyFormat` is `"html"`. - **attachments** (array (MemoryStoredFile)) Array items: ### Responses #### 201 - response Empty response body ### Example Usage ```bash curl -X POST "http://connhex-notifications.connhex/notify" \ -H "Content-Type: application/json" \ -d '{ "userId": "string", "target": "admin@connhex.com", "targets": [ "admin@connhex.com", "user@connhex.com" ], "medium": "email", "payload": "value", "attachments": [ "value" ] }' ``` ``` -------------------------------- ### Schema: MemoryStoredFile Source: https://connhex.com/api/notifications/latest/api.json Schema definition for MemoryStoredFile ```markdown ## Schema: MemoryStoredFile Schema definition for MemoryStoredFile **Type:** object ``` -------------------------------- ### Schema: CreateNotificationDto Source: https://connhex.com/api/notifications/latest/api.json Schema definition for CreateNotificationDto ```markdown ## Schema: CreateNotificationDto Schema definition for CreateNotificationDto **Type:** object - **userId** (string): User ID of the target Connhex user. In order to deliver the notification, `userId`, `target`, or `targets` must be specified. - **target** (string): Notification target: can be an email address, a phone number or a telegram account. (example: "admin@connhex.com") - **targets** (array (string)): Notification targets: an array of target addresses (emails, phone numbers, device tokens, etc.). In order to deliver the notification, `userId`, `target`, or `targets` must be specified. (example: ["admin@connhex.com","user@connhex.com"]) - **medium** (string (email|telegram|sms|slack|discord|fcm|msteams)) (required) ("email"|"telegram"|"sms"|"slack"|"discord"|"fcm"|"msteams") - **payload** (object) (required) - **title** (string) (required): Subject / title of the notification. - **body** (string) (required): Main content of the notification. - **bodyFormat** (object): Controls how `body` is interpreted for email notifications. - `"text"` (default): plain text, wrapped in the built-in HTML email template. - `"html"`: `body` is treated as a complete HTML document and sent as-is. When set to `"html"`, the fields `preview`, `incipit`, `conclusion`, and `footer` are ignored. Has no effect on non-email channels (Telegram, SMS, FCM, etc.). - **preview** (string): Email preview text shown in the inbox before opening the message. Ignored when `bodyFormat` is `"html"`. - **incipit** (string): Opening text displayed before the main body. Ignored when `bodyFormat` is `"html"`. - **conclusion** (string): Closing text displayed after the main body. Ignored when `bodyFormat` is `"html"`. - **footer** (string): Footer text displayed at the bottom of the email. Ignored when `bodyFormat` is `"html"`. - **attachments** (array (MemoryStoredFile)) Array items: ``` -------------------------------- ### API Overview: connhex-notifications Source: https://connhex.com/api/notifications/latest/api.json OpenAPI specification version 1.2.0 ```yaml # connhex-notifications # Version: 1.2.0 OpenAPI specification # Base URL: http://connhex-notifications.connhex ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.