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

Loading...