Losant

Losant Webhooks API

The Webhooks API from Losant — 2 operation(s) for webhooks.

Documentation GitHub OpenAPI

Operations 5

GET /applications/{applicationId}/webhooks Returns the webhooks for an application #

POST /applications/{applicationId}/webhooks Create a new webhook for an application #

GET /applications/{applicationId}/webhooks/{webhookId} Retrieves information on a webhook #

PATCH /applications/{applicationId}/webhooks/{webhookId} Updates information about a webhook #

DELETE /applications/{applicationId}/webhooks/{webhookId} Deletes a webhook #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/losant/openapi/losant-webhooks-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/losant:losant-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Platform Webhooks API
  version: 1.31.0
  description: User API for accessing platform data
servers:
- url: https://api.losant.com
security:
- bearerAuth: []
tags:
- name: Webhooks
paths:
  /applications/{applicationId}/webhooks:
    get:
      operationId: webhooks.get
      summary: Returns the webhooks for an application
      tags:
      - Webhooks
      parameters:
      - name: applicationId
        in: path
        required: true
        description: ID associated with the application
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: sortField
        in: query
        required: false
        description: Field to sort the results by
        schema:
          type: string
          enum:
          - name
          - id
          - creationDate
          - lastUpdated
          default: name
        example: name
      - name: sortDirection
        in: query
        required: false
        description: Direction to sort the results by
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        example: asc
      - name: page
        in: query
        required: false
        description: Which page of results to return
        schema:
          type: string
          default: 0
        example: 0
      - name: perPage
        in: query
        required: false
        description: How many items to return per page
        schema:
          type: string
          default: 100
        example: 10
      - name: filterField
        in: query
        required: false
        description: Field to filter the results by. Blank or not provided means no filtering.
        schema:
          type: string
          enum:
          - name
        example: name
      - name: filter
        in: query
        required: false
        description: Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
        schema:
          type: string
        example: my*webhook
      responses:
        '200':
          description: Collection of webhooks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if application was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - webhooks.get
    post:
      operationId: webhooks.post
      summary: Create a new webhook for an application
      tags:
      - Webhooks
      parameters:
      - name: applicationId
        in: path
        required: true
        description: ID associated with the application
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      responses:
        '201':
          description: Successfully created webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if application was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhookPost'
        description: New webhook information
      x-losant-auth-scopes:
      - webhooks.post
  /applications/{applicationId}/webhooks/{webhookId}:
    get:
      operationId: webhook.get
      summary: Retrieves information on a webhook
      tags:
      - Webhooks
      parameters:
      - name: applicationId
        in: path
        required: true
        description: ID associated with the application
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: webhookId
        in: path
        required: true
        description: ID associated with the webhook
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ed78e7ae143cd83dc4aab
      responses:
        '200':
          description: Webhook information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if webhook was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - webhook.get
    patch:
      operationId: webhook.patch
      summary: Updates information about a webhook
      tags:
      - Webhooks
      parameters:
      - name: applicationId
        in: path
        required: true
        description: ID associated with the application
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: webhookId
        in: path
        required: true
        description: ID associated with the webhook
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ed78e7ae143cd83dc4aab
      responses:
        '200':
          description: Updated webhook information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if webhook was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhookPatch'
        description: Object containing new properties of the webhook
      x-losant-auth-scopes:
      - webhook.patch
    delete:
      operationId: webhook.delete
      summary: Deletes a webhook
      tags:
      - Webhooks
      parameters:
      - name: applicationId
        in: path
        required: true
        description: ID associated with the application
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: webhookId
        in: path
        required: true
        description: ID associated with the webhook
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ed78e7ae143cd83dc4aab
      - name: includeWorkflows
        in: query
        required: false
        description: If the workflows that utilize this webhook should also be deleted.
        schema:
          type: string
        example: true
      responses:
        '200':
          description: If webhook was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/success'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if webhook was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - webhook.delete
components:
  schemas:
    error:
      title: Error
      description: Schema for errors returned by the API
      type: object
      properties:
        type:
          type: string
        message:
          type: string
        validationErrors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              validationMessage:
                type: string
    success:
      title: Success
      description: Schema for reporting a successful operation
      type: object
      properties:
        success:
          type: boolean
          enum:
          - true
    webhook:
      title: Webhook
      description: Schema for a single Webhook
      type: object
      properties:
        id:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        webhookId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        applicationId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        creationDate:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
          maxLength: 32767
        token:
          type: string
          minLength: 1
        responseCode:
          type: integer
          minimum: 100
          maximum: 599
        verificationType:
          type: string
          enum:
          - facebook
          - fitbit
          - none
          - twilio
          - alexa
        verificationCode:
          type: string
          maxLength: 32767
        waitForReply:
          type: boolean
        basicAuthUsername:
          type: string
          maxLength: 255
        basicAuthPassword:
          type: string
          maxLength: 255
        isWebsocket:
          type: boolean
        castBuffersAs:
          type: string
          enum:
          - array
          - binary
          - utf8
          - base64
          - hex
        annotateMultipart:
          type: boolean
        enabled:
          type: boolean
    webhookPost:
      title: Webhook Post
      description: Schema for the body of a Webhook creation request
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
          maxLength: 32767
        responseCode:
          type: integer
          minimum: 100
          maximum: 599
        verificationType:
          type: string
          enum:
          - facebook
          - fitbit
          - none
          - twilio
          - alexa
        verificationCode:
          type: string
          maxLength: 32767
        waitForReply:
          type: boolean
        basicAuthUsername:
          type: string
          maxLength: 255
        basicAuthPassword:
          type: string
          maxLength: 255
        isWebsocket:
          type: boolean
        castBuffersAs:
          type: string
          enum:
          - array
          - binary
          - utf8
          - base64
          - hex
        annotateMultipart:
          type: boolean
        enabled:
          type: boolean
      required:
      - name
      additionalProperties: false
    webhooks:
      title: Webhooks
      description: Schema for a collection of Webhooks
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/webhook'
        count:
          type: integer
        totalCount:
          type: integer
        perPage:
          type: integer
        page:
          type: integer
        filter:
          type: string
        filterField:
          type: string
        sortField:
          type: string
        sortDirection:
          type: string
          enum:
          - asc
          - desc
          - ASC
          - DESC
          - ''
        applicationId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
    webhookPatch:
      title: Webhook Patch
      description: Schema for the body of a Webhook modification request
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
          maxLength: 32767
        responseCode:
          type: integer
          minimum: 100
          maximum: 599
        verificationType:
          type: string
          enum:
          - facebook
          - fitbit
          - none
          - twilio
          - alexa
        verificationCode:
          type: string
          maxLength: 32767
        waitForReply:
          type: boolean
        basicAuthUsername:
          type: string
          maxLength: 255
        basicAuthPassword:
          type: string
          maxLength: 255
        isWebsocket:
          type: boolean
        castBuffersAs:
          type: string
          enum:
          - array
          - binary
          - utf8
          - base64
          - hex
        annotateMultipart:
          type: boolean
        enabled:
          type: boolean
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-derived-from:
  format: bravado 1.0
  by: all/0-working/bravado-to-openapi.py (roadmap#799)
  note: 'every action keeps its own path: resource.path + action.path'