Notifying when a business installs an app (either for the first time or after uninstalling it)
The event is triggered when a business installs an app
there is a distinguish between app install webhooks for an app and for directory/business
Directory/Business
Webhook authorization: using a business or a directory token.
Subscribing to the App Installed webhook:
curl --location --request POST '/platform/v1/webhook/subscribe' \
--header 'Authorization: "Bearer Directory/business API_TOKEN"'\
--header 'Content-Type: application/json' \
--data-raw '{
"event": "app_subscription/installed",
"target_url": "URL"
}'
App Installed Payload Example:
{
"entity_name": "app_subscription",
"event_type": "installed",
"data": {
"business_id": "3fd234234d4",
"app_id": "app unique name"
}
}
App
Webhook authorization: using an app token.
Subscribing to the App Installed webhook
curl --location --request POST '/platform/v1/webhook/subscribe' \
--header 'Authorization: "Bearer App API_TOKEN"'\
--header 'Content-Type: application/json' \
--data-raw '{
"event": "application/installed",
"target_url": "URL"
}'
App Installed Payload Example:
{
"entity_name": "application",
"event_type": "installed",
"data": {
"business_id": "ato23v21hj30krxm",
"app_code_name": "myapp",
"event_time": "2024-03-17T23:11:10.394-06:00"
}
}