Skip to content

feat: support additional webhooks #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2025
Merged

feat: support additional webhooks #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion packages/orb-sync-lib/src/orb-sync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,19 @@ export class OrbSync {
case 'data_exports.transfer_error': {
break;
}
// Ignore accounting sync webhooks for now in the sync engine, given they just add unnecessary writes/load
case 'customer.accounting_sync_failed':
case 'customer.accounting_sync_succeeded':
case 'credit_note.accounting_sync_failed':
case 'credit_note.accounting_sync_succeeded':
case 'invoice.accounting_sync_failed':
case 'invoice.accounting_sync_succeeded': {
break;
}
case 'customer.created':
case 'customer.edited':
case 'customer.credit_balance_depleted':
case 'customer.credit_balance_recovered':
case 'customer.credit_balance_dropped': {
const webhook = parsedData as CustomerWebhook;

Expand All @@ -131,7 +141,9 @@ export class OrbSync {
await syncCustomers(this.postgresClient, [customer], new Date().toISOString());
break;
}

case 'subscription.cancellation_scheduled':
case 'subscription.cancellation_unscheduled':
case 'subscription.plan_change_scheduled':
case 'subscription.created':
case 'subscription.ended':
case 'subscription.plan_changed':
Expand Down
54 changes: 32 additions & 22 deletions packages/orb-sync-lib/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,51 @@
import type { CreditNote, Customer, Invoice, Subscription } from 'orb-billing/resources';

export type OrbWebhookType =
| 'billable_metric.edited'
| 'credit_note.accounting_sync_failed'
| 'credit_note.accounting_sync_succeeded'
| 'credit_note.issued'
| 'credit_note.marked_as_void'
| 'customer.accounting_sync_failed'
| 'customer.accounting_sync_succeeded'
| 'customer.balance_transaction_created'
| 'customer.created'
| 'customer.credit_balance_depleted'
| 'customer.credit_balance_dropped'
| 'customer.credit_balance_recovered'
| 'customer.edited'
| 'subscription.created'
| 'subscription.started'
| 'subscription.edited'
| 'subscription.fixed_fee_quantity_updated'
| 'subscription.ended'
| 'subscription.plan_changed'
| 'subscription.usage_exceeded'
| 'subscription.cost_exceeded'
| 'subscription.plan_version_change_scheduled'
| 'subscription.plan_version_changed'
| 'data_exports.transfer_error'
| 'data_exports.transfer_success'
| 'invoice.accounting_sync_failed'
| 'invoice.accounting_sync_succeeded'
| 'invoice.edited'
| 'invoice.invoice_date_elapsed'
| 'invoice.issue_failed'
| 'invoice.issued'
| 'invoice.manually_marked_as_paid'
| 'invoice.manually_marked_as_void'
| 'invoice.payment_failed'
| 'invoice.payment_processing'
| 'invoice.payment_succeeded'
| 'invoice.edited'
| 'invoice.manually_marked_as_void'
| 'invoice.manually_marked_as_paid'
| 'invoice.undo_mark_as_paid'
| 'invoice.sync_succeded'
| 'invoice.sync_failed'
| 'credit_note.issued'
| 'credit_note.marked_as_void'
| 'invoice.sync_succeded'
| 'invoice.undo_mark_as_paid'
| 'resource_event.test'
| 'subscription.usage_exceeded'
| 'subscription.cancellation_scheduled'
| 'subscription.cancellation_unscheduled'
| 'subscription.cost_exceeded'
| 'data_exports.transfer_success'
| 'data_exports.transfer_error'
| 'customer.balance_transaction_created'
| 'billable_metric.edited';
| 'subscription.cost_exceeded'
| 'subscription.created'
| 'subscription.edited'
| 'subscription.ended'
| 'subscription.fixed_fee_quantity_updated'
| 'subscription.plan_change_scheduled'
| 'subscription.plan_changed'
| 'subscription.plan_version_change_scheduled'
| 'subscription.plan_version_changed'
| 'subscription.started'
| 'subscription.usage_exceeded'
| 'subscription.usage_exceeded';

export type OrbWebhook = {
// Unique to this WebhookEvent resource, and can be used for idempotency (process-once) purposes
Expand Down