API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Webhook schema
  • Get all webhooks
  • Register a webhook
  • Delete a webhook

Was this helpful?

Export as PDF
  1. Others

Webhook

PreviousBreaking changesNextThird-party libraries

Last updated 2 years ago

Was this helpful?

Webhook schema

id long Webhook ID

_cloudId integer Cloud ID (add link)

_warehouseId long? Warehouse ID (add link)

method string Webhook HTTP method to be requested when the entity is updated

url string Webhook URL to be requested when the entity is updated. Validated by a .

payloadEntity string The name of an entity associated with the webhook Can be one of the following: "STOCKLOG", "POINTSLOG", "PRODUCT","ORDERBEAN", "RESERVATION"

payloadVersion string Version of the entity to be put into the webhook body The only value currently supported is "V1" i.e. field names will be compatible with VS/API1

versionDate timestamp? Version date in ISO or Timestamp format

JSON response

{
    "id": <long>,
    "_cloudId": <integer>,
    "_warehouseId": <long>,
    "method": <string>,
    "url": <string>,
    "payloadEntity": <string>,
    "payloadVersion": <string>,
    "versionDate": <timestamp>
}

Get all webhooks

GET https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks

Get a list of all configured webhooks.

Path Parameters

Name
Type
Description

cloudId

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization

string

Bearer accessToken

Register a webhook

POST https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks

Register a new webhook.

Path Parameters

Name
Type
Description

cloudId

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization

string

Bearer accessToken

Delete a webhook

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks/:webhookId

Delete a single webhook identified by its ID.

Path Parameters

Name
Type
Description

cloudId

integer

ID of the cloud.

webhookId

integer

ID of the webhook to delete.

Headers

Name
Type
Description

Authorization

string

Bearer accessToken

regex