Integration Actions

https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Below are the various requests that can be performed against the Integration resource, as well as the expected parameters and the potential responses.

Delete

Deletes an integration

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, integration.*, or integration.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
INTEGRATION_ID	ID associated with the integration	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
includeWorkflows	N	If the workflows that utilize this integration should also be deleted.		includeWorkflows=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Successful Responses

Code	Type	Description
200	Success	If integration was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if integration was not found

Get

Retrieves information on an integration

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, integration.*, or integration.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
INTEGRATION_ID	ID associated with the integration	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Successful Responses

Code	Type	Description
200	Integration	integration information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if integration was not found

Patch

Updates information about an integration

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, integration.*, or integration.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
INTEGRATION_ID	ID associated with the integration	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Integration Patch schema. For example, the following would be a valid body for this request:

{
  "topics": [
    "differentTopic"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"topics":["differentTopic"]}' \
    https://api.losant.com/applications/APPLICATION_ID/integrations/INTEGRATION_ID

Successful Responses

Code	Type	Description
200	Integration	Updated integration information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if integration was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Integration

Schema for a single Integration

Integration Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
id:{} 2 keys
▶
integrationId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
credentialName:{} 3 keys
▶
integrationType:{} 2 keys
▶
enabled:{} 1 key
▶
topics:{} 3 keys
▶
azureEventHubConfig:{} 4 keys
▶
googlePubSubConfig:{} 3 keys
▶
mqttConfig:{} 4 keys
▶
particleConfig:{} 4 keys
▶
sqsConfig:{} 4 keys
▶
websocketConfig:{} 4 keys
▶
status:{} 4 keys

Integration Example

▶
root:{} 11 keys
id:"58ec07f20c747f65243d0d76"
integrationId:"58ec07f20c747f65243d0d76"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"Example Integrations"
integrationType:"mqtt"
enabled:true
▶
topics:[] 1 item
▶
mqttConfig:{} 6 keys
▶
status:{} 3 keys

Integration Patch

Schema for the body of an Integration modification request

Integration Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
name:{} 3 keys
▶
enabled:{} 1 key
▶
topics:{} 3 keys
▶
credentialName:{} 1 key
▶
azureEventHubConfig:{} 4 keys
▶
googlePubSubConfig:{} 3 keys
▶
mqttConfig:{} 4 keys
▶
particleConfig:{} 4 keys
▶
sqsConfig:{} 4 keys
▶
websocketConfig:{} 4 keys
additionalProperties:false

Integration Patch Example

▶
root:{} 1 key
▶
topics:[] 1 item

Success

Schema for reporting a successful operation

Success Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
root:{} 1 key
success:true