ALalteg
Webhooks

Get event notification settings

Changed on

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.

get/hooks_settings/{location_id}

Request

  • Base URL
    https://api.alteg.io/api/v1
  • URL
    https://api.alteg.io/api/v1/hooks_settings/{location_id}
  • Auth
    HTTP bearer

Path parameters

location_idnumber required

location ID

Headers

Acceptstring required

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

Content-Typestring required

application/json

Authorizationstring required

Bearer partner_token, User user_token

Response

OK

successboolean

Execution success status (true)

metaobject[]

Metadata (empty array)

Example response

{
  "success": true,
  "data": {
    "company_id": 123456,
    "urls": [
      "https://dev.tools.test.com/test/Hooks"
    ],
    "url_settings": [
      {
        "url": "https://dev.tools.test.com/test/Hooks",
        "active": 0,
        "salon": 1,
        "good": 1,
        "schedule": 1,
        "loyalty_card": 0,
        "self_sending": 0
      }
    ],
    "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": []
}

Changes

  • c23a9551c004Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status