Marketplace

Application Installation for a Location

Changed on

Step 2 of the two-step installation handshake — the partner confirms the installation and delivers integration settings.

Host: this partner callback is served from the https://app.alteg.io > root — not under https://api.alteg.io/api/v1. The full URL is > https://app.alteg.io/marketplace/partner/callback.

After the owner grants access with Connect an Application to a Location the application–location link is pending. Send this callback with your Partner Token (Account settings) to move the link to active, link the system user, and apply the integration settings below.

Confirmation window: you have 12 hours after the owner connects to send this callback. If you do not confirm in time, the link stays pending and the owner must reconnect. Verify the resulting status with Application Status Data for Any Location.

See the end-to-end Install & test your app before moderation guide.

post/marketplace/partner/callback

Request

  • Base URL
    https://app.alteg.io
  • URL
    https://app.alteg.io/marketplace/partner/callback
  • Auth
    HTTP bearer

Headers

Acceptstring required

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

Request body

salon_idnumber required

Location ID.

application_idnumber required

Application ID.

api_keystring

API-key for messaging module.

webhook_urlsstring[]

Location entity webhook destinations installed with the event flags enabled for this application. Newly installed schedule subscriptions emit update events. The separate application lifecycle callback uses callback_url.

chat_urlstring uri

HTTPS URL for the application's Chat iframe in the timetable and appointment UI. For a normal application this is the supported way to install the chat frame during activation.

tips_urlstring uri

Tips integration URL. Used only by compatible application installers.

channelsstring[]

Notification channels enabled for compatible notification applications.

Example request

{
  "salon_id": 123,
  "application_id": 123,
  "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
  "webhook_urls": [
    "https://example.com/webhook"
  ],
  "chat_url": "https://example.com/altegio/chat",
  "tips_url": "https://example.com/altegio/tips"
}

Response

All parameters installed

Changes

    • breaking

      the request property type changed from number to string

    • breaking

      the / request property format changed from no format to uri

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property