Notification

A notification object.

bodystring

the actual content of the notification

creationDatestring<date-time>

the date and time when this notification was created

destinationstring

the target of the notification. for webhooks this will contain the destination endpoint URL, for emails, the email address of the recipient

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

eventstring

the event which triggered the notification, eg. CLIENT_CREATED, only for automated notifications

sendDatestring<date-time>

the timestamp of when the notification was sent

statestring

indicates the status of the notification

Possible values: [SENT, QUEUED, QUEUED_FOR_STREAM, SENDING_ASYNC, FAILED]

typestring

indicates which messaging channel was used for the notification, eg. EMAIL, SMS

Possible values: [EMAIL, SMS, WEB_HOOK, EVENT_STREAM, TASK]

templateKeystring

the encoded key of the template which was used to construct this notification

numRetriesinteger

the count of retries if the notifaction failed to be sent

clientKeystring

the encoded key of the client for whom the notification was intended

failureCausestring

if the message failed to send this will contain the http response code and message body, formatted as a JSON encoded string, received by the system.

failureReasonstring

in cases of failure, this field will contain a reason derived from the http response, eg INVALID_HTTP_RESPONSE

Notification

{
  "body": "string",
  "creationDate": "2024-07-29T15:51:28.071Z",
  "destination": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "event": "string",
  "sendDate": "2024-07-29T15:51:28.071Z",
  "state": "SENT",
  "type": "EMAIL",
  "templateKey": "string",
  "numRetries": 0,
  "clientKey": "string",
  "failureCause": "string",
  "failureReason": "string"
}