Webhook Actions

https://api.losant.com/applications/APPLICATION_ID/webhooks/WEBHOOK_ID

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

Delete

Deletes a webhook

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/webhooks/WEBHOOK_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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
WEBHOOK_ID	ID associated with the webhook	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
includeWorkflows	N	If the workflows that utilize this webhook 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/webhooks/WEBHOOK_ID

Successful Responses

Code	Type	Description
200	Success	If webhook was successfully deleted

Error Responses

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

Get

Retrieves information on a webhook

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/webhooks/WEBHOOK_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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, webhook.*, or webhook.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
WEBHOOK_ID	ID associated with the webhook	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/webhooks/WEBHOOK_ID

Successful Responses

Code	Type	Description
200	Webhook	Webhook information

Error Responses

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

Patch

Updates information about a webhook

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/webhooks/WEBHOOK_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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
WEBHOOK_ID	ID associated with the webhook	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 Webhook Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Webhook",
  "responseCode": 201
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Webhook","responseCode":201}' \
    https://api.losant.com/applications/APPLICATION_ID/webhooks/WEBHOOK_ID

Successful Responses

Code	Type	Description
200	Webhook	Updated webhook information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if webhook 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:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

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

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

Webhook

Schema for a single Webhook

Webhook Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 18 keys
▶
id:{} 2 keys
▶
webhookId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
token:{} 2 keys
▶
responseCode:{} 3 keys
▶
verificationType:{} 2 keys
▶
verificationCode:{} 2 keys
▶
waitForReply:{} 1 key
▶
basicAuthUsername:{} 2 keys
▶
basicAuthPassword:{} 2 keys
▶
isWebsocket:{} 1 key
▶
castBuffersAs:{} 2 keys
▶
annotateMultipart:{} 1 key
▶
enabled:{} 1 key

Webhook Example

▶
(root){} 9 keys
id:"575ed78e7ae143cd83dc4aab"
webhookId:"575ed78e7ae143cd83dc4aab"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Webhook"
token:"the_webhook_token"
responseCode:200
isWebsocket:false

Webhook Patch

Schema for the body of a Webhook modification request

Webhook Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
responseCode:{} 3 keys
▶
verificationType:{} 2 keys
▶
verificationCode:{} 2 keys
▶
waitForReply:{} 1 key
▶
basicAuthUsername:{} 2 keys
▶
basicAuthPassword:{} 2 keys
▶
isWebsocket:{} 1 key
▶
castBuffersAs:{} 2 keys
▶
annotateMultipart:{} 1 key
▶
enabled:{} 1 key
additionalProperties:false

Webhook Patch Example

▶
(root){} 2 keys
name:"My Updated Webhook"
responseCode:201