Available Events

Supported Webhook Events

The Reload platform supports exactly 4 webhook events:

1. user.connected: Triggered when a user successfully completes the OAuth flow and connects to your AI agent
2. user.disconnected: Triggered when a user revokes access to your AI agent (subscribe to this to handle token revocation)
3. payment.success: Triggered when a payment is successfully processed for usage charges
4. payment.failed: Triggered when a payment fails due to insufficient balance, spending limits, or other issues

Webhook Payload Structure

All webhook events follow this consistent structure with the event, timestamp, and data fields:

1. user.connected Event Triggered when a user successfully completes the OAuth flow and connects to your AI agent.

   {
     "event": "user.connected",
     "timestamp": "2024-01-15T10:30:00Z",
     "data": {
       "user": {
         "id": "user_id",
         "firstName": "John",
         "lastName": "Doe",
         "email": "[email protected]",
         "connectedAt": "2024-01-15T10:30:00Z"
       },
       "organization": {
         "id": "org_id",
         "name": "Organization Name",
         "displayName": "Display Name"
       },
       "environment": "sandbox"
     }
   }

2. user.disconnected Event Triggered when a user revokes access to your AI agent.

   {
     "event": "user.disconnected",
     "timestamp": "2024-01-15T10:30:00Z",
     "data": {
       "user": {
         "id": "user_id",
         "firstName": "John",
         "lastName": "Doe",
         "email": "[email protected]",
         "disconnectedAt": "2024-01-15T10:30:00Z"
       },
       "organization": {
         "id": "org_id",
         "name": "Organization Name",
         "displayName": "Display Name"
       },
       "environment": "sandbox"
     }
   }

3. payment.success Event Triggered when a payment is successfully processed for usage charges.

   {
     "event": "payment.success",
     "timestamp": "2024-01-15T10:30:00Z",
     "data": {
       "transaction": {
         "id": "transaction_id",
         "amount": 25.50,
         "currency": "USD",
         "status": "completed",
         "createdAt": "2024-01-15T10:30:00Z"
       },
       "user": {
         "id": "user_id",
         "firstName": "John",
         "lastName": "Doe",
         "email": "[email protected]"
       },
       "organization": {
         "id": "org_id",
         "name": "Organization Name",
         "displayName": "Display Name"
       },
       "environment": "sandbox"
     }
   }

4. payment.failed Event Triggered when a payment fails due to insufficient balance, spending limits, or other issues.

   {
     "event": "payment.failed",
     "timestamp": "2024-01-15T10:30:00Z",
     "data": {
       "transaction": {
         "id": "transaction_id",
         "amount": 25.50,
         "currency": "USD",
         "status": "failed",
         "createdAt": "2024-01-15T10:30:00Z"
       },
       "user": {
         "id": "user_id",
         "firstName": "John",
         "lastName": "Doe",
         "email": "[email protected]"
       },
       "organization": {
         "id": "org_id",
         "name": "Organization Name",
         "displayName": "Display Name"
       },
       "failureReason": "Insufficient balance",
       "environment": "sandbox"
     }
   }

   
   

Event-Specific Fields

• user.connected: Includes user.connectedAt timestamp
• user.disconnected: Includes user.disconnectedAt timestamp
• payment.success: Includes transaction object with payment details
• payment.failed: Includes transaction object and failureReason field