Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendConnectorEvent

Relays third-party device events for a connector such as a new device or a device state change event.

Request Syntax


POST /connector-event/ConnectorId HTTP/1.1
Content-type: application/json

{
   "ConnectorDeviceId": "string",
   "DeviceDiscoveryId": "string",
   "Devices": [ 
      { 
         "CapabilityReport": { 
            "endpoints": [ 
               { 
                  "clientClusters": [ "string" ],
                  "clusters": [ 
                     { 
                        "attributes": [ 
                           { 
                              "id": "string",
                              "name": "string",
                              "value": JSON value
                           }
                        ],
                        "commands": [ "string" ],
                        "events": [ "string" ],
                        "fabricIndex": number,
                        "featureMap": number,
                        "generatedCommands": [ "string" ],
                        "id": "string",
                        "name": "string",
                        "publicId": "string",
                        "revision": number,
                        "specVersion": "string"
                     }
                  ],
                  "deviceTypes": [ "string" ],
                  "id": "string",
                  "parts": [ "string" ],
                  "semanticTags": [ "string" ]
               }
            ],
            "nodeId": "string",
            "version": "string"
         },
         "CapabilitySchemas": [ 
            { 
               "CapabilityId": "string",
               "ExtrinsicId": "string",
               "ExtrinsicVersion": number,
               "Format": "string",
               "Schema": JSON value
            }
         ],
         "ConnectorDeviceId": "string",
         "ConnectorDeviceName": "string",
         "DeviceMetadata": JSON value
      }
   ],
   "MatterEndpoint": { 
      "clusters": [ 
         { 
            "attributes": JSON value,
            "commands": { 
               "string" : JSON value 
            },
            "events": { 
               "string" : JSON value 
            },
            "id": "string"
         }
      ],
      "id": "string"
   },
   "Message": "string",
   "Operation": "string",
   "OperationVersion": "string",
   "StatusCode": number,
   "TraceId": "string",
   "UserId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ConnectorId

The id of the connector between the third-party cloud provider and IoT managed integrations.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

ConnectorDeviceId

The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

Note

This parameter is used for cloud-to-cloud devices only.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_.,@-]+

Required: No

DeviceDiscoveryId

The id for the device discovery job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [A-Za-z0-9]+

Required: No

Devices

The list of devices.

Type: Array of Device objects

Required: No

MatterEndpoint

The device endpoint.

Type: MatterEndpoint object

Required: No

Message

The device state change event payload.

This parameter will include the following three fields:

uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)
op: For device state changes, this field must populate as n+d.
cn: The content depends on the OCF resource referenced in ResourcePath.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\sa-zA-Z0-9_.,@-]+

Required: No

Operation

The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

Note

The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

Type: String

Valid Values: DEVICE_COMMAND_RESPONSE | DEVICE_DISCOVERY | DEVICE_EVENT | DEVICE_COMMAND_REQUEST

Required: Yes

OperationVersion

The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 6.

Pattern: [0-9.]+

Required: No

StatusCode

The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.

Type: Integer

Valid Range: Minimum value of 100. Maximum value of 550.

Required: No

TraceId

The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:=_-]+

Required: No

UserId

The id of the third-party cloud provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.,@-]+

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "ConnectorId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

ConnectorId

The id of the connector between the third-party cloud provider and IoT managed integrations.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400