Monitoring Connected Accounts via Webhooks

​

Configuring Your Webhook

• Python
• JavaScript

pip install flask

import json
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    if request.method == 'POST':
        payload = request.json
        print(json.dumps(payload, indent=2))
        return jsonify(success=True), 200
    return jsonify(success=False), 405

if __name__ == '__main__':
    app.run(debug=True, port=5000)

​

Understanding the Webhook Payload

The Admin Webhook delivers a rich JSON payload containing vital information about connected account activities. Let’s explore a sample payload to understand its structure and the data it provides.

​

Sample Payload: Slack Connection Initiation

{
  "event": {
    "method": "POST",
    "path": "/",
    "query": {},
    "client_ip": "3.238.0.124",
    "url": "https://example-webhook-url.com/webhook",
    "headers": {
      "host": "example-webhook-url.com",
      "content-type": "application/json",
      "user-agent": "Composio-Webhook/1.0"
    },
    "body": {
      "type": "connected_account.add.start",
      "timestamp": "2024-10-17T09:10:15.989Z",
      "data": {
        "app_name": "slack",
        "integration_name": "slack_worthy_cyan",
        "integration_id": "dummy-integration-id-12345",
        "body": {},
        "connected_account_id": "dummy-connected-account-id-67890"
      }
    }
  }
}

​

Key Insights from the Payload

1. Event Type: The body.type field is crucial, indicating the specific activity occurring. In this example, "connected_account.add.start" signifies the initiation of a new connection.
2. Application Details: The body.data.app_name field reveals which application the user is connecting to, in this case, “slack”.
3. Integration Information: body.data.integration_name provides the name you’ve assigned to this particular integration within your Composio setup.

​

Event Lifecycle

It’s important to note that the webhook system provides updates throughout the connection process. While this example shows a connected_account.add.start event, you’ll receive a subsequent event with the type connected_account.add.completed once the connection is successfully established. This allows you to track the full lifecycle of user connections and respond accordingly at each stage.

​

Leveraging Admin Webhooks

With this real-time data at your fingertips, you can:

1. Monitor User Onboarding: Track when and how users are connecting to your integration.
2. Enhance User Experience: Provide immediate feedback or assistance to users as they interact with your integration.
3. Troubleshoot Issues: Quickly identify and respond to any connection problems or anomalies.