Some response properties are omitted in this documentation because they are not relevant to external callers. Undocumented properties are subject to be removed or changed at any time.

CustomerId is the Citrix Cloud customer ID.

Type is the type of the object on which the event occurred.

ChangeType is the type of event. For example, Create, Update, etc.

TransactionId identifies the high-level operation that caused the event. This can be used to correlate multiple events if they happen as part of a single transaction, or can also be used when opening a Citrix Cloud support ticket to help Citrix locate further information about calls that fail.

Identity is the identity of the person or service that triggered the event. When a person triggers an event through a UI action or API call, this will be the identity of that person. If an event happens as part of a background operation in Citrix Cloud, this will be the identity of the service that triggered the background operation.

BeforeChange and AfterChange indicate the state of the object before and after the event occurred. Not all events use these fields, and the format of the fields varies for each event that can be triggered. When the fields are used, their content is string-encoded JSON, for example:

"AfterChange":"{\"PublishNotificationId\":\"2518777178829331203_YB2Y1\",\"Destination\":\"acme;*\",\"Component\":\"Citrix Cloud\",\"CreatedDate\":\"2018-04-24T15:15:17.0668796Z\",\"Categories\":[],\"Severity\":0,\"EventId\":\"7df85e7a-79b8-4cc2-abe0-c2f9ba2ec715\",\"Priority\":0,\"Content\":[{\"LanguageTag\":\"en-US\",\"Title\":\"This is a title\",\"Description\":\"This is a description\",\"DetailUri\":null}],\"Data\":null,\"ExternalId\":null}",

TimeStamp indicates the date and time when the event occurred, in RFC 3339 format.

Called when a notification is raised. The BeforeChange property will be null, and the AfterChange property will be string-encoded JSON in this format:

{"PublishNotificationId":"2518777178829331203_YB2Y1","Destination":"acme;*","Component":"Citrix Cloud","CreatedDate":"2018-04-24T15:15:17.0668796Z","Categories":[],"Severity":0,"EventId":"7df85e7a-79b8-4cc2-abe0-c2f9ba2ec715","Priority":0,"Content":[{"LanguageTag":"en-US","Title":"This is a title","Description":"This is a description","DetailUri":null}],"Data":null,"ExternalId":null}

The properties are:

Destination: The customer and administrator targeted by the notification. Customer and administrator are separated with a semicolon (;), and asterisk (*) means “all”.

Component: Component which raised the notification.

CreatedDate: Date when the notification was created. Note that this is not validated; callers can specify any date and time they like. The TimeStamp in the outer payload may be a more accurate indicator.

Categories: Optional list of categories which the notification falls under.

Severity: Severity of the event.

0: Informational.

1: Success.

2: Warning.

3: Error.

Priority: Priority of the event.

0: Normal.

1: Low.

2: High.

3: Urgent.

EventId: ID of the event. Note that this is not validated; callers can create multiple events with the same ID.

Content: The notification content. This is an array and can contain the message in multiple languages.