Get event notification settings

Request

Read location-wide webhook settings. Requires webhook settings read access. url_settings contains the actual flags for each destination; the legacy top-level flags reflect only the first URL. This public API reports configuration, not delivery history.

Security

BearerPartnerUser

Path

location_idnumberrequired

location ID

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/developers/openapi/hooks_settings/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataobject

Object with data

Example:

{
  "company_id": 123456,
  "urls": [
    "https://dev.tools.test.com/test/Hooks"
  ],
  "url_settings": [
    { … }
  ],
  "active": 0,
  "salon": 1,
  "service_category": 0,
  "service": 1,
  "good": 1,
  "master": 1,
  "client": 1,
  "record": 1,
  "schedule": 1,
  "loyalty_card": 0,
  "goods_operations_sale": 1,
  "goods_operations_receipt": 1,
  "goods_operations_consumable": 1,
  "goods_operations_stolen": 1,
  "goods_operations_move": 1,
  "finances_operation": 1,
  "self_sending": 0
}

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": {
    "company_id": 123456,
    "urls": [ … ],
    "url_settings": [ … ],
    "active": 0,
    "salon": 1,
    "service_category": 0,
    "service": 1,
    "good": 1,
    "master": 1,
    "client": 1,
    "record": 1,
    "schedule": 1,
    "loyalty_card": 0,
    "goods_operations_sale": 1,
    "goods_operations_receipt": 1,
    "goods_operations_consumable": 1,
    "goods_operations_stolen": 1,
    "goods_operations_move": 1,
    "finances_operation": 1,
    "self_sending": 0
  },
  "meta": []
}