Everactive Data Service API

Data Services API Overview
Eversensors API overview
Eversensors
Evergateways
Health
- Health API overview
- get system healthget
Webhooks
Mqtt

Data Integrations

MQTT Subscription

Everactive Air Gap API

Air Gap API Overview
Config
Health
- get system healthget
Gateways
Sensors
Fulltime Waveform

Gateway Configuration

GW API Overview
network

Everactive Data Service API

Data Services API Overview
Eversensors API overview
Eversensors
Evergateways
Health
- Health API overview
- get system healthget
Webhooks
Mqtt

Data Integrations

MQTT Subscription

Everactive Air Gap API

Air Gap API Overview
Config
Health
- get system healthget
Gateways
Sensors
Fulltime Waveform

Gateway Configuration

GW API Overview
network

get webhooks

get https://api.data.everactive.com/ds/v1/webhooks

Retrieve the configuration of multiple webhook subscriptions.

URL Expired

The URL for this request expired after 30 days.

Query Params

event-type

string

Filter the webhook subscriptions by their event type.
A case-insensitive database match string.
Returns all gateways whose event-type value matches this string.

page

int32

required

≥ 1

Defaults to 1

A one-based index for the first page number to return from a paginated call.

page-size

int32

≥ 1

Defaults to 50

The maximum number of items to return per page.

sort-by

string

The field to use for the sort order in the returned list of webhook subscriptions.

sort-dir

string

The direction to sort the list of results, ascending or descending.

Responses

Response body

object

data

array of objects

data

object

string

The unique id of the webhook subscription.

callbackUrl

string

required

The callback URL that Evercloud will post sensor readings to. Must be HTTPS.

eventType

string

required

Defaults to sensor_reading

The type of events that the webhook will receive.

sensor_reading gateway_status

enabled

boolean

Defaults to false

Specifies whether the webhook is enabled.

customer

object

headers

array of objects

Additional headers to forward with every HTTP request.
Headers are case-insensitive and no duplicate headers are allowed.

headers

object

key

string

required

The HTTP header name.

value

string

required

The HTTP header value.

paginationInfo

object

Details about a paginated result set.

page

integer

required

The current page of data.

pageSize

integer

required

The maximum number of items that will be included on a page.

totalItems

integer

required

The total number of items.

totalPages

integer

required

The total number of pages given the pageSize and totalItems when the request was returned.

Response body

object

code

string

required

A code that uniquely identifies the error type, e.g. error_validation.

message

string

required

A description of the error code.

errors

array of objects

A collection of sub-errors that are encompassed by the top-level error. Validation errors will often have one or more specific fields that did not pass validation, this collection will describe the specific errors.

errors

object

code

string

required

A code that uniquely identifies the error type, e.g. error_no_value.

field

string

Errors for a specific field passed in the body will indicate which field caused the error.

message

string

required

A description of the error.

401

The request did not include the correct authorization or the included authorization has expired.

403

The requested resource is not accessible to the currently authenticated client.

Updated over 1 year ago

create webhook

get webhook

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.data.everactive.com/ds/v1/webhooks?page=1&page-size=50' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

create webhook

get webhook

Did this page help you?

Everactive Data Service API
Data Services API Overview
Eversensors API overview
Eversensors
get a machine time waveformget
get list of eversensor machine time waveformsget
get eversensor last readingget
get eversensor readingsget
get eversensorsget
Evergateways
get gateway status v1 seriesget
get gateway status v3 seriesget
get gateway daily status v3 seriesget
update gatewayput
get gatewayget
get gatewaysget
Evergateways API overview
Health
get system healthget
Health API overview
Webhooks
delete webhookdelete
partial update webhookpatch
update webhookput
get webhookget
get webhooksget
create webhookpost
Webhooks API overview
Mqtt
delete mqtt subscriptiondelete
update mqtt subscriptionput
get an mqtt subscriptionget
get the list of mqtt subscriptionsget
create mqtt subscriptionpost

Data Integrations
MQTT Subscription

Everactive Air Gap API
Air Gap API Overview
Config
delete-clientdelete
get clientsget
create api clientpost
Health
get system healthget
Gateways
get gateway status messagesget
get gateway credentialsget
patch gatewaypatch
get gatewayget
get gatewaysget
create gatewaypost
Sensors
get sensor fulltime waveform readingget
get all fulltime waveform readings metadataget
get all readingsget
get sensor readingsget
get sensorget
get sensorsget
create sensorpost
Fulltime Waveform

Gateway Configuration
GW API Overview
network
Rotate Gateway Public User Certificatepost
Set NTP Configurationpost
Get NTP Configurationget
Updated the MQTT service configurationpost
Get MQTT service configurationget
Update Ethernet configurationpost
Get Ethernet configurationget
Retrieve the network configurationget

Everactive Data Service API
Data Services API Overview
Eversensors API overview
Eversensors
get a machine time waveformget
get list of eversensor machine time waveformsget
get eversensor last readingget
get eversensor readingsget
get eversensorsget
Evergateways
get gateway status v1 seriesget
get gateway status v3 seriesget
get gateway daily status v3 seriesget
update gatewayput
get gatewayget
get gatewaysget
Evergateways API overview
Health
get system healthget
Health API overview
Webhooks
delete webhookdelete
partial update webhookpatch
update webhookput
get webhookget
get webhooksget
create webhookpost
Webhooks API overview
Mqtt
delete mqtt subscriptiondelete
update mqtt subscriptionput
get an mqtt subscriptionget
get the list of mqtt subscriptionsget
create mqtt subscriptionpost

Data Integrations
MQTT Subscription

Everactive Air Gap API
Air Gap API Overview
Config
delete-clientdelete
get clientsget
create api clientpost
Health
get system healthget
Gateways
get gateway status messagesget
get gateway credentialsget
patch gatewaypatch
get gatewayget
get gatewaysget
create gatewaypost
Sensors
get sensor fulltime waveform readingget
get all fulltime waveform readings metadataget
get all readingsget
get sensor readingsget
get sensorget
get sensorsget
create sensorpost
Fulltime Waveform

Gateway Configuration
GW API Overview
network
Rotate Gateway Public User Certificatepost
Set NTP Configurationpost
Get NTP Configurationget
Updated the MQTT service configurationpost
Get MQTT service configurationget
Update Ethernet configurationpost
Get Ethernet configurationget
Retrieve the network configurationget

200Retrieve the configuration of multiple webhook subscriptions.

400The request is invalid.