Function getSystemCustomErrorMsgByKey

getSystemCustomErrorMsgByKey(
    key:
        | "INTERNAL_SERVER_ERROR"
        | "UNAUTHORIZED"
        | "UNKNOWN_ERROR"
        | "VALIDATION_ERROR"
        | "INVALID_VERIFICATION_CODE"
        | "VERIFICATION_CODE_EXPIRED"
        | "WEBHOOK_HEADERS_MISSING"
        | "USER_NOT_VERIFIED"
        | "INVALID_PHONE_NUMBER"
        | "USER_NOT_FOUND"
        | "PROFILE_NOT_FOUND"
        | "CONTACT_NOT_FOUND"
        | "PHONE_NOT_FOUND"
        | "EMAIL_NOT_FOUND"
        | "ADDRESS_NOT_FOUND"
        | "USER_ALREADY_VERIFIED"
        | "PHONE_ALREADY_VERIFIED"
        | "EMAIL_ALREADY_VERIFIED"
        | "USER_ALREADY_EXISTS"
        | "USER_CREATION_FAILED"
        | "USER_UPDATE_FAILED"
        | "USER_DELETE_FAILED"
        | "SERVICE_UNAVAILABLE"
        | "PROFILE_CREATION_FAILED"
        | "PROFILE_UPDATE_FAILED"
        | "CONTACT_CREATION_FAILED"
        | "CONTACT_UPDATE_FAILED"
        | "CONTACT_DELETE_FAILED"
        | "PHONE_CREATION_FAILED"
        | "PHONE_UPDATE_FAILED"
        | "PHONE_DELETE_FAILED"
        | "EMAIL_CREATION_FAILED"
        | "EMAIL_UPDATE_FAILED"
        | "EMAIL_DELETE_FAILED"
        | "ADDRESS_CREATION_FAILED"
        | "ADDRESS_UPDATE_FAILED"
        | "ADDRESS_DELETE_FAILED"
        | "WEBHOOK_SECRET_NOT_CONFIGURED"
        | "WEBHOOK_SIGNATURE_INVALID",
): SystemCustomErrorMessageDataType
Retrieves structured error metadata (title, message, and code) for a specific error key.

This utility is primarily used for sending error events by key not error code
Parameters
- key:
      | "INTERNAL_SERVER_ERROR"
      | "UNAUTHORIZED"
      | "UNKNOWN_ERROR"
      | "VALIDATION_ERROR"
      | "INVALID_VERIFICATION_CODE"
      | "VERIFICATION_CODE_EXPIRED"
      | "WEBHOOK_HEADERS_MISSING"
      | "USER_NOT_VERIFIED"
      | "INVALID_PHONE_NUMBER"
      | "USER_NOT_FOUND"
      | "PROFILE_NOT_FOUND"
      | "CONTACT_NOT_FOUND"
      | "PHONE_NOT_FOUND"
      | "EMAIL_NOT_FOUND"
      | "ADDRESS_NOT_FOUND"
      | "USER_ALREADY_VERIFIED"
      | "PHONE_ALREADY_VERIFIED"
      | "EMAIL_ALREADY_VERIFIED"
      | "USER_ALREADY_EXISTS"
      | "USER_CREATION_FAILED"
      | "USER_UPDATE_FAILED"
      | "USER_DELETE_FAILED"
      | "SERVICE_UNAVAILABLE"
      | "PROFILE_CREATION_FAILED"
      | "PROFILE_UPDATE_FAILED"
      | "CONTACT_CREATION_FAILED"
      | "CONTACT_UPDATE_FAILED"
      | "CONTACT_DELETE_FAILED"
      | "PHONE_CREATION_FAILED"
      | "PHONE_UPDATE_FAILED"
      | "PHONE_DELETE_FAILED"
      | "EMAIL_CREATION_FAILED"
      | "EMAIL_UPDATE_FAILED"
      | "EMAIL_DELETE_FAILED"
      | "ADDRESS_CREATION_FAILED"
      | "ADDRESS_UPDATE_FAILED"
      | "ADDRESS_DELETE_FAILED"
      | "WEBHOOK_SECRET_NOT_CONFIGURED"
      | "WEBHOOK_SIGNATURE_INVALID"
  The unique identifier from SYSTEM_CUSTOM_ERROR_EVENTS.
Returns SystemCustomErrorMessageDataType
The corresponding error object containing display text and the error code.
Example
```
// Displaying a toast message when a database error occurs
const errorInfo = getSystemCustomErrorMsgByKey(SYSTEM_CUSTOM_ERROR_EVENTS.DB_CONNECTION_ERROR);

return res.status(400).json({error: errorInfo})
```
- Defined in events/http.events.ts:365

Function getSystemCustomErrorMsgByKey

Parameters

Returns SystemCustomErrorMessageDataType

Example

Settings