Miracle Docs

Tenant Event Catalog

Events available to tenant-level webhook endpoints. This includes all merchant-visible events plus tenant-specific events for merchant lifecycle, compliance, operations, and platform management.

Tenant-Only Events

These events are visible to tenant and platform endpoints only. Merchants cannot subscribe to them.

Merchant Lifecycle

EventTrigger
merchant.createdA new merchant is created within your tenant
merchant.status_changedMerchant status changes (e.g., pending to live, live to suspended)
merchant.approvedMerchant approved (pending_approval to live)
merchant.suspendedMerchant suspended by operator

KYB (Know Your Business)

EventTrigger
kyb.submittedKYB application submitted for review
kyb.approvedKYB application approved
kyb.rejectedKYB application rejected

Settlement

EventTrigger
settlement.createdSettlement created
settlement.finalizedSettlement finalized, financial statement ready

Balance

EventTrigger
balance.negativeA merchant balance has gone negative
balance.entry_createdNew ledger entry created (any type)

Note: balance.threshold_reached (low balance alert) and balance.available (T+N transition) are also visible to merchants.

Adjustment

EventTrigger
adjustment.createdOperator created adjustment entries
adjustment.approvedAdjustment approved (if 4-eyes required)

Rolling Reserve

EventTrigger
rolling_reserve.releasedRolling reserve hold matured and released

Provider Settlement

EventTrigger
provider_settlement.createdOperator created provider settlement record
provider_settlement.confirmedProvider settlement confirmed (funds arrived)
provider_settlement.failedProvider settlement failed

Partner Settlement

EventTrigger
partner_settlement.createdPartner settlement statement created (draft)
partner_settlement.finalizedPartner settlement statement finalized

3DS Configuration

EventTrigger
terminal.3ds_config.updatedTerminal 3DS configuration changed
merchant.3ds_config.updatedMerchant 3DS defaults changed

Fee Schedule

EventTrigger
fee_schedule.activatedFee schedule activated and applied
fee_schedule.archivedFee schedule archived

User Lifecycle

EventTrigger
user.invitedInvitation sent to a new user
user.activatedUser completed signup via invitation
user.updatedUser non-status fields changed
user.disabledUser disabled by admin
user.enabledUser re-enabled by admin
user.lockedUser locked (admin action or IdP brute-force sync)
user.deactivatedUser soft-deleted
user.invitation_expiredInvitation expired (batch job)
user.invitation_cancelledInvitation cancelled by admin

API Key

EventTrigger
api_key.createdNew API key created
api_key.revokedAPI key revoked
api_key.expiredAPI key expired (batch job)

Routing

EventTrigger
routing.rule_activatedRouting rule activated
routing.rule_archivedRouting rule archived
routing.config_changedTenant routing configuration version changed
routing.no_route_foundTransaction blocked because no matching route was found

Fraud

EventTrigger
fraud.markedTransaction marked as fraudulent

Alerts

EventTrigger
alert.triggeredAlert rule matched a condition
alert.resolvedAlert condition resolved

Webhook Operational

EventTrigger
webhook.delivery_failedMax retries exhausted for a webhook endpoint
webhook.endpoint_disabledEndpoint auto-disabled due to persistent delivery failures

Merchant-Visible Events

Tenant endpoints also receive all events that merchants can subscribe to. These events are visible at all three levels (merchant, tenant, platform):

Payment

EventTrigger
payment.createdPayment created
payment.processingPayment sent to provider
payment.succeededPayment completed successfully
payment.failedPayment declined
payment.canceledPayment canceled
payment.requires_actionShopper action required (3DS, redirect)
payment.requires_capturePayment authorized, awaiting capture
payment.capturedCapture completed
payment.refundedFull refund completed
payment.partially_refundedPartial refund completed

Refund

EventTrigger
refund.createdRefund created
refund.succeededRefund completed
refund.failedRefund declined

Checkout

EventTrigger
checkout.session.createdCheckout session created
checkout.session.completedCheckout session completed (payment succeeded)
checkout.session.expiredCheckout session expired

Dispute

EventTrigger
dispute.createdDispute opened
dispute.updatedDispute updated
dispute.wonDispute resolved in merchant's favor
dispute.lostDispute resolved against merchant

Payout

EventTrigger
payout.createdPayout created
payout.succeededPayout completed
payout.failedPayout declined

Withdrawal

EventTrigger
withdrawal.createdWithdrawal request created
withdrawal.approvedWithdrawal approved by operator
withdrawal.rejectedWithdrawal rejected by operator
withdrawal.canceledWithdrawal self-canceled by entity
withdrawal.succeededWithdrawal completed
withdrawal.failedWithdrawal execution failed at provider

Balance

EventTrigger
balance.availableFunds transitioned pending to available (T+N)
balance.threshold_reachedBalance reached configured threshold (low balance alert)

For the full merchant event reference with payload details, see the merchant event catalog.

On this page