Disruptive Documentation

Enumeration Data​Connector.​Push​Type 

public enum PushType: Equatable

The mechanism used by a Data Connector to push device events to an external service.

%61 DataConnector.PushType DataConnector.PushType Equatable Equatable DataConnector.PushType->Equatable

Member Of

DataConnector

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend to an external service. It can be set up to send specific types of events to a configurable endpoint through an HTTP POST request.

Conforms To

Equatable

Enumeration Cases

http​Push 

case httpPush(url: String, signatureSecret: String, headers: [String: String])

This mechanism pushes device events to an external service using an HTTP POST request, and is effectively a webhook.

An HTTP push Data Connector allows you to specify a signature secret that will be used to sign each every event sent from the Data Connector. The signature will be included as a JWT in a header. Read more about it in the Signing events section of the Data Connectors article on the developer website.

Parameters:

  • url: The URL of the external service that the HTTP POST requests will be pushed to.

  • signatureSecret: Used to sign each event pushed from the Data Connector. See details above.

  • headers: Any additional headers that should be included with every event pushed from the Data Connector.

unknown 

case unknown(value: String)

The push type received for the Data Connector was unknown. Added for backwards compatibility in case a new push type is added on the backend, and not yet added to this client library.