Common Request

Notification requests to customer systems via HTTP API are used to notify customer systems in real-time of resource status changes, event triggers, task completions, and other relevant events.

Basic Information

• Transport Protocol: HTTPS
• Request Method: POST
• Content Type: application/json
• Character Encoding: UTF-8

Endpoint

POST /api/v1/users

Request Headers

Field Name	Required	Description
Content-Type	Mandatory	Fixed as application/json
X-SFD-Notification-From	Mandatory	Service which notification is sent from

Request Body

Field Name	Type	Required	Description
id	string	Mandatory	Unique notification identifier, consistent with X-Notification-Id in the request header
event	string	Mandatory	Notification event (e.g., "SYNC_STREAM_STATUS_EVENT", "SYNC_RECORDING_RESULT_EVENT")
version	string	Mandatory	Notification API version, matches X-Notification-Version header
timestamp	number	Mandatory	Unix timestamp in milliseconds when the notification was generated
data	object	Mandatory	Detailed notification data, structure varies by notification type

Example

Request

POST {3RD_PARTY_ENDPOINT} HTTP/1.1

Content-Type: application/json
X-SFD-Notification-From: {SERVICE_NAME}

{
  "id": "notif-1234567890",
  "event": {EVENT},
  "version": "v1.0",
  "timestamp": 1715568240000,
  "data": {
    Object for the specified notification
  }
}