Webhook Types

{
  "data": {
    "disbursement": {
      "id": "string",
      "allowedMethods": "DisbursementMethod[]",
      "amount": "int",
      "authorizedIdentities": "array[]",
      "clientId": "string",
      "fundingAccountId": "string",
      "matterId": "string",
      "metadata": "object",
      "publicKey": "string",
      "status": "DisbursementStatus"
    },
    "oldDisbursement": {
      "id": "string",
      "allowedMethods": "DisbursementMethod[]",
      "amount": "int",
      "authorizedIdentities": "array[]",
      "clientId": "string",
      "fundingAccountId": "string",
      "matterId": "string",
      "metadata": "object",
      "publicKey": "string",
      "status": "DisbursementStatus"
    }
  },
  "type": "disbursement.updated",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "firm": {
      "id": "string"
    }
  },
  "type": "firm.updated",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "statement": {
      "id": "string"
    }
  },
  "type": "statement.created",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "statement": {
      "id": "string"
    }
  },
  "type": "statement.updated",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "storedPaymentMethod": {
      "id": "string"
    }
  },
  "type": "stored_payment_method.created",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "storedPaymentMethod": {
      "id": "string"
    }
  },
  "type": "stored_payment_method.deleted",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "storedPaymentMethod": {
      "id": "string"
    }
  },
  "type": "stored_payment_method.updated",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{transaction: {
  id: string;
  achReturnCode: string | null;
  achReturnReason: string | null;
  aggregatePaymentLink: { id: string } | null;
  amountProcessed: number;
  amountRefunded: number;
  bankAccount: { id: string };
  cardBrand: string | null;
  client: { id: string } | null;
  createdOn: Date;
  disbursement: { id: string } | null;
  disbursementAmounts: DisbursementAmounts | null;
  errorMessage: string | null;
  firm: { id: string };
  lastFour: string | null;
  matter: { id: string } | null;
  payerEmail: string | null;
  payerName: string | null;
  payerNotes: string | null;
  paymentMethod: TransactionPaymentMethod;
  payment: { id: string } | null;
  paymentLink: { id: string } | null;
  settledOn: Date | null;
  standingLink: { id: string } | null;
  status_v2: PaymentTxnStatus2;
  storedPaymentMethod: { id: string } | null;
  subscription: { id: string } | null;
  type: PaymentTxnType;
  }
};

{
  "data": {
    "transaction": {
      "id": "string"
    }
  },
  "type": "transaction.funds_in_transit",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "transaction": {
      "id": "string"
    }
  },
  "type": "transaction.deposited",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "originalTransaction": {
      "id": "string"
    },
    "voidTransaction": {
      "id": "string"
    }
  },
  "type": "transaction.voided",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "originalTransaction": {
      "id": "string"
    },
    "refundTransaction": {
      "id": "string"
    }
  },
  "type": "transaction.refunded",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "originalTransaction": {
      "id": "string"
    },
    "refundTransaction": {
      "id": "string"
    }
  },
  "type": "transaction.partially_refunded",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}

{
  "data": {
    "originalTransaction": {
      "id": "string"
    },
    "returnTransaction": {
      "id": "string"
    }
  },
  "type": "transaction.ach_returned",
  "firmId": "<firm_id>",
  "eventId": "<event_id>"
}