Marketplace

Webhook from Altegio About Application Events

Changed on

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.

post/marketplace_webhook

Request

  • Base URL
    https://your-app.invalid
  • URL
    https://your-app.invalid/marketplace_webhook
  • Auth
    none required

Request body

salon_idnumber required

Location ID.

application_idnumber required

Application ID.

event'uninstall' | 'freeze' | 'payment' required

Event Slug.

partner_tokenstring required

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

payment_idinteger

Marketplace payment ID. Present for payment.

amountnumber

Payment amount. Present for payment.

currency_isostring

ISO currency code. Present for payment.

discountnumber nullable

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 nullable

Marketplace tariff option. Present for payment.

signstring

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

Example request

{
  "salon_id": 123,
  "application_id": 123,
  "event": "uninstall",
  "partner_token": "yasdfkjah2328aj"
}

Response

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

Changes

    • warning

      deleted the header request parameter Accept

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new payment enum value to the request property