Skip to main content

Send notification

POST 
/notify

Send notification

Request​

Body

required
    userId string

    User ID of the target Connhex user. In order to deliver the notfification, userId or target must be specified.

    target string

    Notification target: can be an email address, a phone number or a telegram account. In order to deliver the notfification, userId or target must be specified.

    medium stringrequired

    Possible values: [email, telegram, sms, slack, discord, fcm, msteams]

    payload objectrequired
    title stringrequired
    body stringrequired
    preview string
    incipit string
    conclusion string
    footer string
    attachments object[]
  • Array [
  • ]

Responses​

curl -L -X POST 'https://connhex.com/notify' \
-H 'Content-Type: application/json' \
--data-raw '{
  "userId": "string",
  "target": "admin@connhex.com",
  "medium": "email",
  "payload": {
    "title": "string",
    "body": "string",
    "preview": "string",
    "incipit": "string",
    "conclusion": "string",
    "footer": "string"
  },
  "attachments": [
    {}
  ]
}'
Request Collapse all
Body required
{

  "userId": "string",

  "target": "admin@connhex.com",

  "medium": "email",

  "payload": {

    "title": "string",

    "body": "string",

    "preview": "string",

    "incipit": "string",

    "conclusion": "string",

    "footer": "string"

  },

  "attachments": [

    {}

  ]

}