Webhooks
Last updated
Last updated
remote.it supports webhooks which allow you to receive HTTP push notifications for device online/offline notifications. This allows you to build integrations on top of remote.it. Some examples are to perform debug operations on devices which go offline, send messages, or check for the device IP change when it comes online.
Your webhook consumer is a simple HTTP endpoint. It is not an email address or a general website url. It must satisfy the following conditions:
It's available in a publicly accessible HTTPS, non-localhost URL
It will respond to the remote.it Webhook push (HTTP POST request) with a HTTP 200
("OK") response within 5 seconds
If a delivery fails (i.e. server unavailable or responded with a non-200 HTTP status code), the push might subsequently be retried a couple of times. If the webhook URL continues to be unresponsive the webhook might be disabled by remote.it, and must be re-enabled again manually.
For additional information on Webhooks, you can use any of these resources:
requestbin.com is a great tool for testing webhooks
You can add a webhook endpoint to your account, by signing in to your account and navigating to the account page. Select the types of notifications you to which you wish to subscribe and enter the webhook url.
A webhook url is not a email address or a general website url. If you wish to receive email notifications select the email checkbox.
The body of a webhook call contains the latest state information of the device or service. This can be recorded in a database to review later. You will receive unique webhook notifications for the device and each service registered to that device when their state changes.
Value | Description |
---|---|
Address | Public IP Address of the device/service |
Device | Unique ID of the device or service |
Email address of the owner of the device | |
Name | Name of the device or service |
State | {online/offline} state being recorded |
Time | When the state change happened in UTC time string format. |
Type | Type of state change that happened |
Online notifications will be sent almost immediately.
Offline notifications will be sent almost immediately, if the system was shutdown or rebooted using specific "shutdown" or "reboot" commands. Using command line options to stop and start the connectd daemons directly will also send notifications immediately.
If the reason for your device going offline is an unexpected interruption of power or internet connection, it may take up to 15 minutes to receive the offline notification.