Reference List
Customers
Object - context_str | Event - event | Description |
|---|---|---|
| customer | insert | A customer is created |
| customer | update | A customer is updated |
| customer | join | A contact is added to the customer |
| customer | super | The main contact is changed |
| customer | delete | A customer is deleted |
| customer | nightly | The nightly event occurs |
| customer | status | A customer status has changed |
Users (Contacts)
Object - context_str | Event - event | Description |
|---|---|---|
| user | insert | A user is created |
| user | update | A user is updated |
| user | delete | A user is deleted |
Quotes
Object - context_str | Event - event | Description |
|---|---|---|
| quote | status | A quote status has changed |
| quote | insert | A quote is created |
| quote | update | A quote is updated |
| quote | nightly | The nightly event occurs |
| quote | won | A quote is accepted |
| quote | lost | A quote is rejected |
Invoices
Object - context_str | Event - event | Description |
|---|---|---|
| invoice | status | An invoice status has changed |
| invoice | insert | An invoice is created |
| invoice | update | An invoice is updated |
| invoice | void | An invoice is voided |
| invoice | nightly | The nightly event occurs |
Subscriptions (Packages)
Object - context_str | Event - event | Description |
|---|---|---|
| package | status | A subscription status has changed |
| package | insert | A subscription is created |
| package | update | A subscription is updated |
| package | generate | A subscription has generated an invoice |
| package | paycycle | The invoice cycle for a subscription changes |
| package | paymethod | The pay method for a subscription changes |
| package | cancel | A subscription is cancelled |
| package | updowngrade | A subscription is upgraded or downgraded |
| package | suspend | A subscription is suspended |
| package | unsuspend | A subscription is unsuspended |
| package | nightly | The nightly event occurs |
| package | hold | The subscription invoice generation is delayed |
| package | uncancel | The cancelled subscription is un-canceled |
Items (Products, Discounts)
Object - context_str | Event - event | Description |
|---|---|---|
| item | insert | An item is created |
| item | update | An item is updated |
Transactions (Payments, Refunds, Credits)
Object - context_str | Event - event | Description |
|---|---|---|
| transaction | status | A transaction status has changed |
| transaction | insert | A transaction is created |
| transaction | apply | A transaction is applied to an invoice |
| transaction | void | A transaction is marked void |
ACH/eChecks
Object - context_str | Event - event | Description |
|---|---|---|
| ach | insert | An ACH/eCheck account created |
| ach | update | ACH/eCheck account updated |
| ach | delete | ACH/eCheck account deleted |
| ach | autopay | ACH/eCheck account approved for autopay |
Credit Cards
Object - context_str | Event - event | Description |
|---|---|---|
| creditcard | insert | Credit card created |
| creditcard | update | Credt card updated |
| creditcard | delete | Credit card deleted |
| creditcard | expiring | Credit card is expiring soon |
| creditcard | expired | Credit card has expired |
| creditcard | autopay | Credit card has been approved for autopay |
Tokenized Payment Methods
Object - context_str | Event - event | Description |
|---|---|---|
| tokenized | insert | A tokenized payment method is created |
| tokenized | update | A tokenized payment method is edited |
| tokenized | delete | A tokenized payment method is deleted |
Admin Users
Object - context_str | Event - event | Description |
|---|---|---|
| admin | insert | An admin is created |
| admin | update | An admin is edited |
| admin | delete | An admin is deleted |
| admin | login | An admin logged into ChargeOver |
Notes
Object - context_str | Event - event | Description |
|---|---|---|
| note | insert | A note created |