Skip to content
/
Get event notification se...

Developer Tools (1.0.0)

APIs for partners building integrations with the Altegio platform. Base URL: https://api.alteg.io/api

Available Methods

Marketplace — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks. Webhooks — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change. VoIP Integration — Connect telephony systems to match incoming calls with client records and log call history. Dictionaries — Reference data for building forms and validations: countries, cities, business types.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/developers/openapi/
Production
https://api.alteg.io/api/v1/

Marketplace

Marketplace application management, billing, and installation.

Operations

Webhooks

Event subscription and webhook configuration.

Operations

Get event notification settings

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
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: {"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"good":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "urls": [ … ],
    "active": 0,
    "salon": 1,
    "service_category": 0,
    "service": 1,
    "good": 1,
    "master": 1,
    "client": 1,
    "record": 1,
    "goods_operations_sale": 1,
    "goods_operations_receipt": 1,
    "goods_operations_consumable": 1,
    "goods_operations_stolen": 1,
    "goods_operations_move": 1,
    "finances_operation": 1
  },
  "meta": []
}

Change Event Notification Settings

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
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

Bodyapplication/json
activenumberrequired

1 - notifications are active, 0 - not active

urlsArray of arraysrequired

List of addresses to send notifications to

Example: ["https://dev.tools.test.com/test/Hooks"]
salonnumber

1 - send events by location entity, 0 - do not send

Example: 1
service_categorynumber

1 - send events by service category entity, 0 - do not send

servicenumber

1 - send events by service entity, 0 - do not send

Example: 1
goodnumber

1 - send events by product entity, 0 - don't send

Example: 1
masternumber

1 - send events by team member entity, 0 - don't send

Example: 1
clientnumber

1 - send events by client entity, 0 - don't send

Example: 1
recordnumber

1 - send events by appointment entity, 0 - do not send

Example: 1
goods_operations_salenumber

1 - send events by the product sale entity, 0 - do not send

Example: 1
goods_operations_receiptnumber

1 - send events by the entity arrival of products, 0 - do not send

Example: 1
goods_operations_consumablenumber

1 - send events by the consumable write-off entity, 0 - do not send

Example: 1
goods_operations_stolennumber

1 - send events by the product write-off entity, 0 - do not send

Example: 1
goods_operations_movenumber

1 - send events by the product movement entity, 0 - no send

Example: 1
finances_operationnumber

1 - send events by entity financial operation, 0 - no send

Example: 1
self_sendingnumber

1 - The webhook creator will receive events triggered by their own actions, 0 - The webhook creator will not receive events triggered by their own actions

curl -i -X POST \
  '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: application/json' \
  -d '{
    "urls": [
      "https://dev.tools.test.com/test/Hooks"
    ],
    "active": 0,
    "salon": 1,
    "service_category": 0,
    "service": 1,
    "good": 1,
    "master": 1,
    "client": 1,
    "record": 1,
    "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
  }'

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"good":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "urls": [ … ],
    "active": 0,
    "salon": 1,
    "service_category": 0,
    "service": 1,
    "master": 1,
    "client": 1,
    "record": 1,
    "goods_operations_sale": 1,
    "goods_operations_receipt": 1,
    "goods_operations_consumable": 1,
    "goods_operations_stolen": 1,
    "goods_operations_move": 1,
    "finances_operation": 1
  },
  "meta": []
}

VoIP Integration

Telephony integration endpoints.

Operations

Dictionaries

Reference data (countries, cities, business types).

Operations