Webhook Events with Contract Product Triggers

Capture events for product activation, renewal, cancellation, and status changes

This guide covers information on webhook events and contract product category triggers.

Contract product category triggers descriptions

Contract product category triggersDescription
Contract product activatedContract product is activated
Contract product billing cycle changedBilling cycle for contract product was changed
Contract product cancel request approvedCancellation request approved
Contract product cancel request deleted clientCancel request removed by client
Contract product cancelledContract product is cancelled
Contract product client label changedClient label was changed on contract product
Contract product closedContract product is closed
Contract product consolidation offConsolidation disabled
Contract product createdWhen a new product/service contract is created
Contract product due date changedDue date for contract product was updated
Contract product expire manual renewalManual renewal expiry
Contract product failed consolidation invoiceConsolidation invoice failed
Contract product invoicing startInvoicing has started for contract product
Contract product manual status offManual status deactivated
Contract product ownership changedOwnership of the contract product changed
Contract product payment intervalPayment interval updated
Contract product price changedPrice for contract product was adjusted
Contract product provisioning requires fraud reviewProvisioning requires fraud review
Contract product renew onRenew flag was enabled for contract product
Contract product retention flaggedRetention flagged on product
Contract product retention lostRetention failed/lost
Contract product retention savedRetention succeeded
Contract product setup values require confirmationAdditional setup confirmation required
Contract product suspendedContract product is suspended
Contract product trial expires soonThe trial period is expiring soon
Contract product trial migration failedMigration to trial failed
Contract product trial to paidConverted from trial to paid
Contract product awaiting activationContract product is pending activation
Contract product cancel intervalCancel interval set on contract product
Contract product cancel request createdCancellation request created
Contract product cancel request deleted userCancel request deleted by staff
Contract product cancelled with reasonContract product is cancelled with reason provided
Contract product close intervalClose interval set
Contract product company address VAT updatedCompany address VAT updated
Contract product consolidation onConsolidation enabled for contract product
Contract product currency changedCurrency for contract product was changed
Contract product expire auto renewalAuto-renewal expiry
Contract product expire notificationExpiry notification sent
Contract product invoice intervalInvoice interval has changed
Contract product invoicing stopInvoicing stopped for contract product
Contract product manual status onManual status for contract product was activated
Contract product package changedPackage for contract product was changed
Contract product pre terminateProduct is approaching scheduled termination
Contract product provision configuration changedProvisioning configuration updated
Contract product renew offRenew flag was disabled for contract product
Contract product renewedContract product renewed
Contract product retention in progressRetention action is in progress
Contract product retention noneNo retention action needed
Contract product setup failedSetup of the contract product failed
Contract product suspend intervalContract product is suspended
Contract product trial endedTrial for contract product has ended
Contract product trial migrated newNew migration to a trial begins
Contract product trial startedTrial for contract product has started
Contract product unsuspendedContract product suspension is lifted

Webhook contract product event triggers

Product lifecycle automation

Category: Contract Product
Triggers:

  • Contract product created
  • Contract product awaiting activation
  • Contract product activated
  • Contract product suspended
  • Contract product unsuspended
  • Contract product setup failed

Description: For automation/pipeline steps tracking when products are ordered, activated, suspended, unsuspended, or fail on setup.

Contract product renewal automation

Category: Contract Product
Triggers:

  • Contract product renew on
  • Contract product renew off
  • Contract product renewed
  • Contract product expire notification
  • Contract product expire manual renewal
  • Contract product expire auto renewal

Description: For actions and notifications relating to renewal cycles and product expiry.

Contract product trial and migration

Category: Contract Product
Triggers:

  • Contract product trial started
  • Contract product trial ended
  • Contract product trial expires soon
  • Contract product trial to paid
  • Contract product trial migrated new
  • Contract product trial migration failed

Description: Useful for tracking and automating trial conversion processes.

Contract product billing and change management

Category: Contract Product
Triggers:

  • Contract product billing cycle changed
  • Contract product price changed
  • Contract product package changed
  • Contract product currency changed
  • Contract product invoice interval
  • Contract product payment interval

Description: Ideal for automating updates during plan upgrades, downgrades, price or cycle changes.

Contract product cancellation and retention

Category: Contract Product
Triggers:

  • Contract product cancel request created
  • Contract product cancel request approved
  • Contract product cancel request deleted client
  • Contract product cancel request deleted user
  • Contract product cancel interval
  • Contract product cancelled
  • Contract product cancelled with reason
  • Contract product closed
  • Contract product close interval
  • Contract product retention flagged
  • Contract product retention saved
  • Contract product retention lost
  • Contract product retention in progress
  • Contract product retention none

Description: Enables tracking and workflows for the entire cancellation and retention journey.

Contract product consolidation

Category: Contract Product
Triggers:

  • Contract product consolidation on
  • Contract product consolidation off
  • Contract product failed consolidation invoice

Description: For consolidation automation in billing cycles or batch invoicing.