Legacy Lifecycle Event Webhooks
These webhooks have been superseded by the LIFECYCLE webhooks, (see the Lifecycle Event Dictionary) but will continue to be available so as to not break existing implementations. Tight recommends updating your application to consume the new LIFECYCLE webhooks, contact api@tight.com with any questions.
LIFECYCLE_EVENT
A "LIFECYCLE_EVENT" webhook will contain a JSON body like the following:
{
"userId": "fake_userId",
"type": "LIFECYCLE_EVENT",
"event": "TRANSACTION_PULL_COMPLETED",
"eventData": {
"integrationName": "PLAID"
}
}
Some of the possible events and recommended messaging to notify your users are listed below:
| Webhook Type | Event | Example message |
|---|---|---|
| LIFECYCLE_EVENT | BANK_TRANSFER_ADDED | 1 new bank transfer from *3333 needs to be reviewed. |
| LIFECYCLE_EVENT | BANK_TRANSFER_AUTO_TAGGED | 2 new bank transfers were automatically matched. |
| LIFECYCLE_EVENT | BANK_TRANSFER_UPDATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | EXPENSE_ADDED | 4 new expenses from *3333 need to be tagged. |
| LIFECYCLE_EVENT | EXPENSE_AUTO_TAGGED | 2 new expenses from *3333 were auto-tagged. |
| LIFECYCLE_EVENT | EXPENSE_REVIEW_NEEDED | 1 new expense from *3333 needs review. |
| LIFECYCLE_EVENT | EXPENSE_RULE_ACCEPTED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | EXPENSE_UPDATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | INTEGRATION_ADDED | N/A (useful for triggering next set of onboarding steps/messages) |
| LIFECYCLE_EVENT | INTEGRATION_ERROR | Re-link your Citi account |
| LIFECYCLE_EVENT | INTEGRATION_REPAIRED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | INVOICE_CREATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | INVOICE_PAID | Bill Tanner has paid Invoice HUR-121. |
| LIFECYCLE_EVENT | INVOICE_PAYMENT_METHOD_STORED | Bill Tanner has added a card on file for future invoices. |
| LIFECYCLE_EVENT | INVOICE_SETUP_COMPLETED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | INVOICE_VIEWED | Bill Tanner has opened Invoice HUR-121. |
| LIFECYCLE_EVENT | JOURNAL_ENTRY_UPDATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | PAYMENT_PROCESSING_SETUP_COMPLETED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | RECEIPT_ATTACHED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | REVENUE_ADDED | 3 new income transactions from *3332 need to be tagged. |
| LIFECYCLE_EVENT | REVENUE_AUTO_TAGGED | 1 new income transaction from *3332 was auto-tagged. |
| LIFECYCLE_EVENT | REVENUE_RULE_ACCEPTED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | REVENUE_UPDATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | TAX_PAYMENT_ADDED | 1 new tax payment from *3333 needs to be reviewed. |
| LIFECYCLE_EVENT | TAX_PAYMENT_UPDATED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | TAX_SETUP_COMPLETED | N/A (useful for user analytics) |
| LIFECYCLE_EVENT | TRANSACTION_PULL_COMPLETED | Historical transactions are ready to be tagged |
Additional use cases
The above lifecycle events can be used in varying ways depending on your product's use case. For example, if your product manages corporate/employee spend, it may benefit your user experience to make the
EXPENSE_ADDEDevent trigger a push notification prompting the user to add a receipt image. TheeventDataincluded with theEXPENSE_ADDEDevent contains the information necessary to route the user to the exact transaction that requires a receipt.
Updated about 2 months ago