1. Home
  2. Docs
  3. Documentation
  4. Working with Congether
  5. Services and WebHooks

Services and WebHooks

With “Services” you can integration other applications and services with Congether. In this case, Congether will send the services a HTTP Post-Request with event-informations, given to the subscribed event-types.

Manage services

To manage your services, go to the “Admin”-Page and click on “Services”. You see now a list of already existing services and can add a new one.

Adding a new service

To add a new service, click on the create-button. Type in a Description for your service and provide the valid endpoint-address for the service. At last you can specify the subscribed events. After you created a service, Congether will generate a “Shared Secret”, which is now visible, if you open the service-dialog once again. This secret will be used to set a signature in each POST-Request.

WebHook-Request

In case of an subscribed event, Congether will perform a WebHook-Request (POST-Request) to the given endpoint address.

The request will contain additional Header-Informations and the body-content as JSON (application/json).

POST-Header

The request will contain following header-informations.

KeyTypeContent-Description
X-WEBHOOK-MESSAGEstringType of Event
X-WEBHOOK-SECRETstringHMAC SHA256-Signature
of UTF8-Content of the Request-Body and secured with the “Shared Secret”.
Content-Typestringapplication/json

Events

Application created

Header-Informations and Trigger

Message-TypeAppCreatedMessage
TriggerUser created a new application

Body

PropertyTypeDescription
AppNamestringName of application
AppIdstringIdentifier of application

Device provisioned

Header-Informations and Trigger

Message-TypeDeviceProvisionedMessage
TriggerDevice has been provisioned

Body

PropertyTypeDescription
DeviceIdstringId (Guid) of device
DeviceIdentifierstringDevice-identifier
EnvironmentPlatformstringPlatform (e.g. Windows)
EnvironmentArchitecturestringOS-Architecture (e.g. x64)
EnvironmentRuntimestringRuntime (e.g. .NET)
EnvironmentOSstringOS and Version
EnvironmentIpAddressstringIP Address of client
EnvironmentHostnamestringHostname of client

Installation provisioned

Header-Informations and Trigger

Message-TypeInstallationProvisionedMessage
TriggerDevice has been provisioned

Body

PropertyTypeDescription
InstallationIdstringId (Guid) of installation
EnvironmentPlatformstringPlatform (e.g. Windows)
EnvironmentArchitecturestringOS-Architecture (e.g. x64)
EnvironmentRuntimestringRuntime (e.g. .NET)
EnvironmentOSstringOS and Version
EnvironmentIpAddressstringIP Address of client
EnvironmentHostnamestringHostname of client

Tracer: Log-Message (Error) occured

Header-Informations and Trigger

Message-TypeTracerLogErrorMessage
TriggerLog Entry of handle-type “error” has occured

Body

PropertyTypeDescription
TimestampdateUTC Timestamp
IdentifierstringTracer-Config-Identifier
LogValuestringValue (Content) of Log Entry
EnvironmentPlatformstringPlatform (e.g. Windows)
EnvironmentArchitecturestringOS-Architecture (e.g. x64)
EnvironmentRuntimestringRuntime (e.g. .NET)
EnvironmentOSstringOS and Version
EnvironmentIpAddressstringIP Address of client
EnvironmentHostnamestringHostname of client

Tracer: Log-Message (Warning) occured

Header-Informations and Trigger

Message-TypeTracerLogWarningMessage
TriggerLog Entry of handle-type “warning” has occured

Body

PropertyTypeDescription
TimestampdateUTC Timestamp
IdentifierstringTracer-Config-Identifier
LogValuestringValue (Content) of Log Entry
EnvironmentPlatformstringPlatform (e.g. Windows)
EnvironmentArchitecturestringOS-Architecture (e.g. x64)
EnvironmentRuntimestringRuntime (e.g. .NET)
EnvironmentOSstringOS and Version
EnvironmentIpAddressstringIP Address of client
EnvironmentHostnamestringHostname of client

Tracer: Metric-Threshold exceeded

Header-Informations and Trigger

Message-TypeTracerMetricThresholdMessage
TriggerMetric exceeded specified upper or lower threshold.

Body

PropertyTypeDescription
TimestampdateUTC Timestamp
IdentifierstringTracer-Config-Identifier
ValuenumberValue of metric-entry
ThresholdnumberValue of threshold
IsUpperThresholdboolExceeded threshold is the “upper” threshold
IsLowerThresholdboolExceeded threshold is the “lower” threshold
EnvironmentPlatformstringPlatform (e.g. Windows)
EnvironmentArchitecturestringOS-Architecture (e.g. x64)
EnvironmentRuntimestringRuntime (e.g. .NET)
EnvironmentOSstringOS and Version
EnvironmentIpAddressstringIP Address of client
EnvironmentHostnamestringHostname of client

Was this article helpful to you? Yes No

How can we help?