Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

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

post/connector-event/{ConnectorId}

Path parameters

ConnectorIdstring required

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

Request body

UserIdstring password

The id of the third-party cloud provider.

Operation'DEVICE_COMMAND_RESPONSE' | 'DEVICE_DISCOVERY' | 'DEVICE_EVENT' | 'DEVICE_COMMAND_REQUEST' required
<p>The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.</p> <note> <p>The field op can have a value of "I" or "U". The field "cn" will contain the capability types.</p> </note>
OperationVersionstring

The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see <a href="https://openconnectivity.org/specs/OCF_Security_Specification_v1.0.0.pdf">OCF Security Specification</a>.

StatusCodeinteger

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

Messagestring password
<p>The device state change event payload.</p> <p>This parameter will include the following three fields:</p> <ul> <li> <p> <code>uri</code>: <code>schema auc://&lt;PARTNER-DEVICE-ID&gt;/ResourcePath</code> (The <code>Resourcepath</code> corresponds to an OCF resource.)</p> </li> <li> <p> <code>op</code>: For device state changes, this field must populate as <code>n+d</code>.</p> </li> <li> <p> <code>cn</code>: The content depends on the OCF resource referenced in <code>ResourcePath</code>.</p> </li> </ul>
DeviceDiscoveryIdstring

The id for the device discovery job.

ConnectorDeviceIdstring password
<p>The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).</p> <note> <p>This parameter is used for cloud-to-cloud devices only.</p> </note>
TraceIdstring

The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.

Response

Success

ConnectorIdstring required

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