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.Organization, all.User, 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.read, all.Organization, all.Organization.read, all.User, 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.Organization, all.User, 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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.