Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

When you connect Stigg to Zuora, Stigg automatically configures Zuora to send certain billing events back to Stigg in real time. This enables Stigg to stay in sync with payment and subscription state changes that originate in Zuora. This page documents every event category Zuora sends to Stigg, the data fields Stigg reads from each callout, and what Stigg does when it receives the event.

How incoming events work

Stigg processes events from Zuora in two groups: Automatically configured by Stigg — when you connect the Zuora integration, Stigg creates the following objects in your Zuora tenant for each custom event:
  • Event trigger — a condition-based rule that fires when a specific change is detected
  • Callout template — defines the HTTP POST Zuora sends to Stigg’s incoming webhook URL, including the payload fields
  • Notification definition — links the event trigger to the callout template, activating delivery
Stigg automatically sets up seven custom events: StiggInvoicePaidEvent, StiggInvoicePostedEvent, StiggSubscriptionCancelledEvent, StiggSubscriptionUpdatedEvent, StiggScheduledOrderCompletedEvent, StiggCustomerCanceledEvent, and StiggPaymentFailedEvent. When the integration is removed, Stigg deletes these callouts, notifications, and event triggers from Zuora. Processed by Stigg if receivedCustomer and Subscription events are standard Zuora change notifications. Stigg’s webhook endpoint handles them when Zuora sends them, but Stigg does not automatically create or manage their callout configuration in Zuora.

Event categories

Customer — account payment method updated

Event categoryCustomer
Event typeStandard Zuora account change notification
Trigger conditionAny update to a Zuora Account record
Stigg listens for account updates to keep customer payment method information current. When a customer adds or replaces their default payment method in Zuora, Stigg receives the update and reflects it. Data fields Stigg reads
FieldZuora source
AccountIdAccount.Id
DefaultPaymentMethodIdDefaultPaymentMethod.Id
DefaultPaymentMethodCreditCardTypeDefaultPaymentMethod.CreditCardType
DefaultPaymentMethodBankNameDefaultPaymentMethod.BankName
DefaultPaymentMethodCreditCardMaskNumberDefaultPaymentMethod.CreditCardMaskNumber
DefaultPaymentMethodCreditCardExpirationMonthDefaultPaymentMethod.CreditCardExpirationMonth
DefaultPaymentMethodCreditCardExpirationYearDefaultPaymentMethod.CreditCardExpirationYear
What Stigg does Stigg compares the incoming DefaultPaymentMethodId with the one stored on the customer record. If it has changed, Stigg updates the customer’s stored default payment method (type, last 4 digits, expiration month/year) or clears it if the new value is empty.

Subscription — subscription status changed

Event categorySubscription
Event typeStandard Zuora subscription change notification
Trigger conditionAny update to a Zuora Subscription record
Stigg listens for subscription status changes so that cancellations initiated in Zuora are reflected in Stigg automatically. Data fields Stigg reads
FieldZuora source
SubscriptionIdSubscription.Id
SubscriptionOriginalIdSubscription.OriginalId
SubscriptionPreviousSubscriptionIdSubscription.PreviousSubscriptionId
SubscriptionStatusSubscription.Status
SubscriptionCancelledDateSubscription.CancelledDate
What Stigg does When SubscriptionStatus is Cancelled, Stigg cancels the matching subscription in Stigg using the SubscriptionCancelledDate as the cancellation timestamp. If the Stigg subscription was already cancelled or expired, Stigg moves the billing ID to a historical field and no further action is taken.

StiggInvoicePaidEvent — invoice paid

Event categoryStiggInvoicePaidEvent
Event typeCustom event trigger + callout + notification
Base objectInvoice
Trigger conditionchangeType =~ ['UPDATE'] && Invoice.Balance == 0
Callout nameStigg Invoice Paid Callout
Notification nameStigg Invoice Paid Notification
This event fires when an invoice balance reaches zero (i.e., the invoice is fully paid). Stigg uses it to activate subscriptions that were paused pending payment, apply pending subscription updates, and record the payment against the subscription’s invoice history. Data fields Stigg reads
FieldZuora source
InvoiceIdInvoice.Id
AccountIdAccount.Id
What Stigg does
  1. Looks up the subscription associated with the invoice by fetching the invoice’s line items from Zuora.
  2. If the subscription is not currently active in Stigg, activates it.
  3. Applies any pending future subscription updates (e.g. a scheduled plan change that was waiting on payment).
  4. Records the invoice as PAID on the Stigg subscription’s latest invoice record.
  5. Dispatches a SUBSCRIPTION_UPDATED event to Stigg’s event log.

StiggInvoicePostedEvent — invoice posted

Event categoryStiggInvoicePostedEvent
Event typeCustom event trigger + callout + notification
Base objectInvoice
Trigger conditionchangeType =~ ['INSERT','UPDATE'] && Invoice.Status == 'Posted' && Invoice.Balance > 0
Callout nameStigg Invoice Posted Callout
Notification nameStigg Invoice Posted Notification
This event fires when an invoice is posted in Zuora with an outstanding balance (i.e., not yet paid). Stigg uses it to record the open invoice against the subscription. Data fields Stigg reads
FieldZuora source
InvoiceIdInvoice.Id
AccountIdAccount.Id
What Stigg does
  1. Looks up the subscription associated with the invoice by fetching the invoice’s line items from Zuora. Skips the event if the invoice has no associated subscription (e.g. one-time charges).
  2. Records the invoice as OPEN on the Stigg subscription’s latest invoice record.
  3. Dispatches a SUBSCRIPTION_UPDATED event to Stigg’s event log.

StiggSubscriptionCancelledEvent — subscription cancelled

Event categoryStiggSubscriptionCancelledEvent
Event typeCustom event trigger + callout + notification
Base objectSubscription
Trigger conditionSubscription.Status == 'Cancelled'
Callout nameStigg Subscription Cancelled Callout
Notification nameStigg Subscription Cancelled Notification
This event fires when a Zuora subscription transitions to Cancelled. Stigg uses it to mirror the cancellation on its side. Data fields Stigg reads
FieldZuora source
SubscriptionIdSubscription.Id
SubscriptionOriginalIdSubscription.OriginalId
SubscriptionPreviousSubscriptionIdSubscription.PreviousSubscriptionId
SubscriptionStatusSubscription.Status
SubscriptionCancelledDateSubscription.CancelledDate
What Stigg does When SubscriptionStatus is Cancelled, Stigg cancels the matching subscription using SubscriptionCancelledDate as the cancellation timestamp. If the Stigg subscription was already cancelled or expired, Stigg moves the billing ID to a historical field and no further action is taken.

StiggSubscriptionUpdatedEvent — subscription version updated

Event categoryStiggSubscriptionUpdatedEvent
Event typeCustom event trigger + callout + notification
Base objectSubscription
Trigger conditionchangeType == 'INSERT' && Subscription.IsLatestVersion == true
Callout nameStigg Subscription Updated Callout
Notification nameStigg Subscription Updated Notification
Zuora creates a new subscription version each time a subscription is amended. This event fires when a new version becomes the latest. Stigg uses it to keep the subscription’s billing ID pointing to the current Zuora version. Data fields Stigg reads
FieldZuora source
SubscriptionIdSubscription.Id
SubscriptionOriginalIdSubscription.OriginalId
AccountIdAccount.Id
What Stigg does
  1. Finds all Zuora subscription IDs that share the same SubscriptionOriginalId.
  2. Matches them to a single Stigg subscription by the customer’s billing ID.
  3. Updates the Stigg subscription’s billing ID to the latest Zuora version ID and refreshes the billing link URL.
  4. Dispatches a SUBSCRIPTION_UPDATED event to Stigg’s event log.

StiggScheduledOrderCompletedEvent — scheduled order executed

Event categoryStiggScheduledOrderCompletedEvent
Event typeCustom event trigger + callout + notification
Base objectOrder
Trigger conditionOrder.IsScheduled == true && Order.Status == 'Completed'
Callout nameStigg Order Scheduled Callout
Notification nameStigg Order Scheduled Notification
When a subscription change is scheduled for a future date (for example, a downgrade at end of billing period), Stigg creates a scheduled Order in Zuora. This event fires when Zuora executes that order, signaling Stigg to apply the corresponding changes on its side. Data fields Stigg reads
FieldZuora source
OrderIdOrder.Id
OrderStatusOrder.Status
OrderIsScheduledOrder.IsScheduled
AccountIdAccount.Id
What Stigg does
  1. Looks up the pending scheduled update(s) in Stigg that were associated with this Zuora Order ID.
  2. Depending on the type of scheduled update:
    • Plan change — provisions a new subscription to the target plan (with any add-ons, billing period, and price overrides from the schedule)
    • Add-on / billable feature / billing period update — updates the existing subscription in-place
    • Migrate to latest — migrates the subscription to the latest published version of its plan
  3. Marks the scheduled update record as Done in Stigg.

StiggCustomerCanceledEvent — customer account canceled

Event categoryStiggCustomerCanceledEvent
Event typeCustom event trigger + callout + notification
Base objectAccount
Trigger conditionchangeType =~ ['UPDATE'] && Account.Status == 'Canceled'
Callout nameStigg Customer Canceled Callout
Notification nameStigg Customer Canceled Notification
This event fires when a Zuora account is set to Canceled. Stigg uses it to archive the corresponding customer. Data fields Stigg reads
FieldZuora source
AccountIdAccount.Id
AccountStatusAccount.Status
What Stigg does
  1. Looks up the Stigg customer by the Zuora Account ID.
  2. If AccountStatus is canceled, archives the customer in Stigg.

StiggPaymentFailedEvent — payment failed

Event categoryStiggPaymentFailedEvent
Event typeCustom event trigger + callout + notification
Base objectPayment
Trigger conditionPayment.Status == 'Error'
Callout nameStigg Payment Failed Callout
Notification nameStigg Payment Failed Notification
This event fires when a Zuora payment attempt fails (status Error). Stigg uses it to transition the subscription to a payment-pending state and record the failure details. Data fields Stigg reads
FieldZuora source
PaymentInvoiceIdPayment.PaymentParts (invoice ID from payment parts)
AccountIdAccount.Id
PaymentGatewayResponsePayment.GatewayResponse
PaymentGatewayResponseCodePayment.GatewayResponseCode
EntityIDEntity.ID
What Stigg does
  1. Fetches the invoice from Zuora by PaymentInvoiceId and looks up the associated subscription.
  2. Records a payment failure event log entry with the gateway error message and code.
  3. If the subscription was active, transitions it to PAYMENT_PENDING status.
  4. Updates the latest invoice record on the subscription with the open, action-required invoice details.
  5. Dispatches a SUBSCRIPTION_UPDATED event to Stigg’s event log.

Summary

Event categoryDirectionEvent setupWhat it updates in Stigg
CustomerZuora → StiggStandard notificationCustomer default payment method
SubscriptionZuora → StiggStandard notificationSubscription cancellation status
StiggInvoicePaidEventZuora → StiggCustom event triggerSubscription active status, invoice record, pending updates
StiggInvoicePostedEventZuora → StiggCustom event triggerSubscription open invoice record
StiggSubscriptionCancelledEventZuora → StiggCustom event triggerSubscription cancellation status
StiggSubscriptionUpdatedEventZuora → StiggCustom event triggerSubscription billing ID and link URL
StiggScheduledOrderCompletedEventZuora → StiggCustom event triggerScheduled plan changes, add-on updates, plan migrations
StiggCustomerCanceledEventZuora → StiggCustom event triggerCustomer archived status
StiggPaymentFailedEventZuora → StiggCustom event triggerSubscription payment-pending status, invoice record