Activity Center external notification integration

ℹ️

Audience: This article is intended for developers and tecnical staff

Syntphony provides the capability via internal API to send external notifications from integrated systems so that they are processed and visible from the Activity Center the same way internal notifications work.

API endpoint. HTTP Request

The endpoint is located within the Syntphony Activity Center API, eventually in the URL as follows:

POST https://[customer-tenant-name]apimanagement.azure-api.net/ActivityCenter/app/setExternalNotification

Required request headers

Header	Value
authorization	authorization bearer token
content-type	application/json
ocp-apim-subscription-key	api management subscription key

Request body

{
  "eventId": string, 
  "uniqueId": string, 
  "title": string, 
  "url": string, 
  "notified": datetime,
  "accounts": string[], 
  "comment": string
}

Model properties

`eventId`

Event type identifier.

Type: string
Required: Yes

`uniqueId`

Unique identifier.

Type: string
Required: No

`title`

Item title.

Type: string
Required: Yes

`url`

Item url.

Type: string
Required: Yes

`notified`

Notification datetime.

Type: dateTime
Required: No

`accounts`

Array of user principal names (upns) of user accounts or groups to be notified. In case of groups, all group members will be notified.

Type: string[]
Required: Yes

`comment`

Comment for the notification

Type: string
Required: No

API Authentication

The API is protected by an Azure EntraID app registration called TogoBackendApi.

The product also provides an Azure EntraID app registration consumer called TogoBackendConsumer already configured with permissions to the TogoBackendApi app.

To obtain the authentication header, an OAuth 2.0 Client Credentials flow must be followed using TogoBackendConsumer AppId and specifying TogoBackendApi as scope. This will retrieve a correct access token with “access_as_application” role which is validated by the backend service.

Feature limitations

There are no special limitations on this feature.

Configuration Analytics