Webhooks Actions

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

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

Get

Returns the webhooks for an application

Method And Url

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

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, webhooks.*, or webhooks.get.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*webhook

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

Successful Responses

Code	Type	Description
200	Webhooks	Collection of webhooks

Error Responses

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

Post

Create a new webhook for an application

Method And Url

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

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, webhooks.*, or webhooks.post.

Request Path Components

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

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 Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Webhook"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Webhook"}' \
    https://api.losant.com/applications/APPLICATION_ID/webhooks

Successful Responses

Code	Type	Description
201	Webhook	Successfully created webhook

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application 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"

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 Post

Schema for the body of a Webhook creation request

Webhook Post Schema

▶
(root){} 5 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
▶
required:[] 1 item
additionalProperties:false

Webhook Post Example

▶
(root){} 1 key
name:"My New Webhook"

Webhooks

Schema for a collection of Webhooks

Webhooks Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Webhooks Example

▶
(root){} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"