Skip to main content

​
Overview

You may want to monitor the status of an integration and trigger notifications from your system each time a user successfully completes an integration using Alloy. This could be useful if you are using the Alloy Link feature to onboard users onto an integration. The integration installation webhook allows Alloy to notify your servers via Webhooks once a user successfully completes an integration. Once you receive a notification, you may choose to trigger additional workflows like notifying the user and initiating other processes within your systems.

​
Registering the Integration Installation Webhook

To get started with this feature, navigate to Settings > General > Integration Installation Webhook from your Alloy embedded dashboard. Then, add your webhook server’s URL to the input field and click save changes.
Now, when a user installs any of the integrations you have created on Alloy, Alloy will notify your webhook servers with the details of that installation. Below is an example response that your server may receive when Alloy sends a webhook notification upon a user successfully connecting their Shopify account to your app. 
{
  "userId": "6749ddb3c68f4d9bbed27c4d",
  "workflowIds": ["665d97562d8169fd95cc8ca2", "66884cb8bc8a1b22a746f03e"],
  "integrationId": "665d974f8466237167bbc4ba",
  "credentials": { "shopify": "6749ddddf9c3eb2808b50d6a" },
  "success": true
}
Once an end-user installs your integration, the integration installation webhook will send details about the integration to your server including the userId andintegrationId.
⌘I