App Webhooks

App webhooks allow you to keep track of how often your application is installed and uninstalled. If the application is paid, you will also receive payment webhooks.

Bulding block configuration

If you want to be notified about your app installation, uninstallation, and payment events, configure an App Webhooks building block in Developer Console. To do that, provide a URL to your backend that will receive the webhooks.

App Webhooks in LiveChat Developer Console

Webhook reference

application_installed

Informs that an application was installed.

Response
Copied!
{
  "applicationID": "aPbNnrwZg",
  "applicationName": "Google Calendar for LiveChat",
  "clientID": "9cbf3a968289727cb3cdfe83ab1d9836",
  "date": "2020-09-14T15:29:53+02:00",
  "event": "application_installed",
  "licenseID": 104130623,
  "payload": {
    "applicationID": "aPbNnrwZg"
  }
}

application_uninstalled

Informs that an application was uninstalled.

Response
Copied!
{
  "applicationID": "aPbNnrwZg",
  "applicationName": "Google Calendar for LiveChat",
  "clientID": "9cbf3a968289727cb3cdfe83ab1d9836",
  "date": "2020-09-14T15:29:49+02:00",
  "event": "application_uninstalled",
  "licenseID": 104130623,
  "payload": {
    "applicationID": "aPbNnrwZg"
  }
}

payment_activated

Informs that the payment process was initiated.

Response
Copied!
{
  "applicationID": "aPbNnrwZg",
  "applicationName": "Google Calendar for LiveChat",
  "clientID": "9cbf3a968289727cb3cdfe83ab1d9836",
  "date": "2020-09-14T15:29:49+02:00",
  "event": "payment_activated",
  "licenseID": 104130623,
  "payload": { 
    "paymentID": "bd5e4a08-e870-48c4-a6d8-6a855e2870f1", 
    "quantity": 1 
  }
}

payment_collected

Informs that the payment process has completed, which means it was successfully collected.

Response
Copied!
{
  "applicationID": "aPbNnrwZg",
  "applicationName": "Google Calendar for LiveChat",
  "clientID": "9cbf3a968289727cb3cdfe83ab1d9836",
  "date": "2020-09-14T15:29:49+02:00",
  "event": "payment_collected",
  "licenseID": 104130623,
  "payload": { 
    "paymentID": "bd5e4a08-e870-48c4-a6d8-6a855e2870f1", 
    "total": 400 
  }
}

payment_cancelled

Informs that a payment was canceled. Possible reasons:

  • The customer uninstalled your app.
  • The customer resigned from LiveChat altogether.
Response
Copied!
{
  "applicationID": "aPbNnrwZg",
  "applicationName": "Google Calendar for LiveChat",
  "clientID": "9cbf3a968289727cb3cdfe83ab1d9836",
  "date": "2020-09-14T15:29:49+02:00",
  "event": "payment_cancelled",
  "licenseID": 104130623,
  "payload": { 
    "paymentID": "bd5e4a08-e870-48c4-a6d8-6a855e2870f1"
  }
}

Questions?

We're happy to provide our support in case you need it. If you have any questions or suggestions, feel free to contact us at developers@livechat.com