Skip to content
/
Webhook from Altegio Abou...

Webhook from Altegio About Application Events

Request

This is an example receiver path on your application backend, not an Altegio API endpoint. Altegio POSTs to the application's configured callback_url. It is separate from location entity webhook_urls.

This section describes how Altegio sends webhook notifications when specific events occur in the application-to-location lifecycle. The following event types are currently supported:

  • uninstall — Sent when the application is disabled on the Altegio side.
  • freeze — Sent when the integration is frozen due to service expiration.
  • payment — Sent after an Altegio Marketplace billing payment is processed.

Lifecycle callbacks are emitted only in the production environment. The partner_token field lets the receiving application verify which partner originated the callback. Compare it with the expected token using a constant-time comparison. A payment event also includes the payment fields documented below and a HMAC signature. Other lifecycle events do not carry that signature.

Configure callback_url in your Altegio Developer Account. There is no partner-facing delivery log, test-send, or replay API for these callbacks.

Bodyapplication/json
salon_idnumberrequired

Location ID.

Example:123
application_idnumberrequired

Application ID.

Example:123
eventstringrequired

Event Slug.

Enum:"uninstall""freeze""payment"
Example:"uninstall"
partner_tokenstringrequired

Partner token included in the JSON body to verify the callback origin.

Example:"yasdfkjah2328aj"
payment_idinteger

Marketplace payment ID. Present for payment.

amountnumber

Payment amount. Present for payment.

currency_isostring

ISO currency code. Present for payment.

discountnumber or null

Applied discount. Present for payment.

period_fromstring

Paid period start. Present for payment.

period_tostring

Paid period end. Present for payment.

payment_datestring

Payment timestamp. Present for payment.

tariff_option_idinteger or null

Marketplace tariff option. Present for payment.

signstring^[a-f0-9]{64}$

HMAC-SHA256 over the URL-encoded salon_id, amount, and discount fields, in that order, using the partner token.

curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace_webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "salon_id": 123,
    "application_id": 123,
    "event": "uninstall",
    "partner_token": "yasdfkjah2328aj",
    "payment_id": 0,
    "amount": 0,
    "currency_iso": "string",
    "discount": 0,
    "period_from": "string",
    "period_to": "string",
    "payment_date": "string",
    "tariff_option_id": 0,
    "sign": "string"
  }'

Responses

From the side of the partner, a response code of successful processing (200-299) is expected.

Response
No content