Skip to content
GetmeDocs
Sign inCreate account

Getting started

  • Getme developer documentation

API Reference

  • Introduction
  • Authentication
  • Errors
  • Idempotent requests
  • Metadata
  • Pagination
  • Request IDs
  • Versioning
  • Webhooks
  • Event Catalog
  • SDKs and CLI

Core Resources

  • Auth
  • Events

Site Resources

  • Forms
  • Sites

Commerce Resources

  • Brands
  • Categories
  • Products
  • Services

Crm Resources

  • Customers

Other Resources

  • Media

Dev Tools

  • CLIBeta
  • Website source with the CLIBeta
  • Webhooks with the CLIBeta
  • SDKsBeta
  • Node SDKBeta
  • Python SDKBeta

Guides

  • Guides
  • Quickstart
  • Website source workflow
  • Webhook handler

Changelog

  • Changelog
  • June 10, 2026 - Developer platform docs beta
  • July 15, 2026 - Install token lifecycle safety
  • July 15, 2026 - Source-first site development
  • July 15, 2026 - Site source navigation warnings
Loading documentation...
HomeAPI referenceEvent Catalog

Event Catalog

110 public webhook events generated from the event contract

2026-06-09110 eventsevents/public/webhook-event.v1.schema.json

billing

invoice.createdAn invoice was created.stablev1invoice.issuedAn invoice was issued.stablev1invoice.paidAn invoice reached paid state.stablev1invoice.payment_failedAn invoice payment attempt failed.stablev1invoice.refundedAn invoice was refunded.stable
v1
invoice.sentAn invoice was sent to a customer.stablev1
invoice.voidedAn invoice was voided.stablev1

bookings

booking.cancelledA booking was cancelled.stablev1booking.completedA booking was completed.stablev1booking.confirmedA booking was confirmed.stablev1booking.createdA booking was created.stablev1booking.heldA booking slot was held while payment, review, or another prerequisite is pending.stablev1booking.payment_requiredA booking requires payment before it can continue or be finalized.stablev1booking.reminderA reminder should be sent for an upcoming booking.stablev1booking.requestedA booking was requested and is awaiting confirmation or another required step.stablev1booking.rescheduledA booking was rescheduled.stablev1

catalog

brand.createdA brand was created.stablev1brand.deletedA brand was deleted.stablev1brand.updatedA brand was updated.stablev1category.createdA category was created.stablev1category.deletedA category was deleted.stablev1category.updatedA category was updated.stablev1product.createdA product was created.stablev1product.deletedA product was deleted.stablev1product.updatedA product was updated.stablev1service.createdA service was created.stablev1service.deletedA service was deleted.stablev1service.updatedA service was updated.stablev1

customers

customer.createdA customer was created.stablev1customer.deletedA customer was deleted.stablev1customer.updatedA customer was updated.stablev1

documents

document_request.approvedA document request was approved.stablev1document_request.createdA document request was created.stablev1document_request.rejectedA document request was rejected.stablev1document_request.sentA document request upload link was sent to a customer.stablev1document_request.submittedA document request was submitted.stablev1

expenses

expense.approvedAn expense was approved.stablev1expense.createdAn expense was created.stablev1expense.paidAn expense was paid.stablev1expense.rejectedAn expense was rejected.stablev1expense.submittedAn expense was submitted for approval.stablev1expense.updatedAn expense was updated.stablev1expense.voidedAn expense was voided.stablev1

forms

form.submittedA storefront or public form was submitted.stablev1

hr

worker.createdA worker was created.stablev1worker.deactivatedA worker was deactivated.stablev1worker.updatedA worker was updated.stablev1

inventory

inventory.stock_changedTracked stock changed for a product or variant inventory item.stablev1inventory.threshold_updatedA low-stock threshold was updated for a product or variant inventory item.stablev1

orders

order.cancelledAn order was cancelled.stablev1order.completedAn order reached completed state.stablev1order.createdAn order was created.stablev1order.fulfilledAn order was fulfilled.stablev1order.fulfillment.status_changedAn order fulfillment lifecycle status changed.stablev1order.fulfillment_requestedAn order was sent to a custom fulfillment service.stablev1order.paidAn order was paid.stablev1order.refundedAn order was refunded.stablev1order.return_approvedAn order return request was approved.stablev1order.return_closedAn order return was closed after returned items were received.stablev1order.return_declinedAn order return request was declined.stablev1order.return_requestedAn order return request was created.stablev1

payments

payment.dispute_closedA payment dispute was closed without a clear won/lost chargeback outcome, such as an inquiry or warning closure.stablev1payment.dispute_lostA payment dispute was resolved against the merchant and may require loss accounting.stablev1payment.dispute_openedA payment dispute or chargeback was opened by the payment provider against a charge. Subscribe to alert your team and begin collecting evidence. The event's `data.object` contains the public dispute resource; see this event's payload schema and example for the exact fields.stablev1payment.dispute_updatedA payment dispute changed — for example its status, stage, evidence deadline, or the provider's details were updated. Subscribe to keep your dispute-handling workflow in sync. The event's `data.object` contains the public dispute resource; see this event's payload schema and example for the exact fields.stablev1payment.dispute_wonA payment dispute was resolved in the merchant's favor.stablev1payment.failedA payment failed.stablev1payment.refundedA payment was refunded.stablev1payment.succeededA payment completed successfully.stablev1payment_account.capability_disabledA merchant payment-account capability became disabled or rejected.stablev1payment_account.capability_enabledA merchant payment-account capability became enabled.stablev1payment_account.charges_disabledMerchant payment account charges became disabled.stablev1payment_account.charges_enabledMerchant payment account charges became enabled.stablev1payment_account.onboarding_completedMerchant payment account became fully ready for charges and payouts.stablev1payment_account.onboarding_startedMerchant payment-account onboarding was started.stablev1payment_account.onboarding_submittedMerchant payment-account onboarding details were submitted.stablev1payment_account.payouts_disabledMerchant payment account payouts became disabled.stablev1payment_account.payouts_enabledMerchant payment account payouts became enabled.stablev1payment_account.verification_past_dueMerchant payment account verification requirements became past due or blocking.stablev1payment_account.verification_requiredMerchant payment account has new verification requirements.stablev1payout.cancelledA payout was cancelled.stablev1payout.createdA payout was created.stablev1payout.failedA payout failed.stablev1payout.paidA payout was paid.stablev1

promotions

promotion.createdA promotion was created.stablev1promotion.deletedA promotion was deleted.stablev1promotion.redeemedA promotion was redeemed.stablev1promotion.updatedA promotion was updated.stablev1

quotes

quote.acceptedA quote was accepted.stablev1quote.convertedA quote was converted to an order or invoice.stablev1quote.createdA quote was created.stablev1quote.declinedA quote was declined.stablev1quote.sentA quote was sent.stablev1

selling_plans

selling_plan.createdA selling plan was created.stablev1selling_plan.deletedA selling plan was deleted.stablev1selling_plan.updatedA selling plan was updated.stablev1

shipping

shipping.label_purchasedA shipping label was successfully purchased for an order and is ready to use. Subscribe to this event to drive fulfillment steps such as notifying the customer, advancing the order's status, or recording the shipment's tracking reference. The event's `data.object` contains the public shipping resource; see this event's payload schema and example for the exact fields.stablev1shipping.label_voidedA shipping label was voided.stablev1shipping.shipment_deliveredA shipment was delivered.stablev1

subscriptions

subscription.cancelledA subscription was cancelled.stablev1subscription.card_setup_requestedA customer must add or confirm a card for a subscription.stablev1subscription.createdA subscription was created.stablev1subscription.pausedA subscription was paused.stablev1subscription.payment_failedA subscription payment failed.stablev1subscription.renewedA subscription renewed.stablev1subscription.resumedA subscription was resumed.stablev1subscription.trial_expiringA subscription trial is nearing its end.stablev1subscription.updatedA subscription was updated.stablev1

website

website.publish_failedA website publish attempt failed after orchestration started.stablev1website.publishedA website was published successfully.stablev1

On this page

  • billing
  • bookings
  • catalog
  • customers
  • documents
  • expenses
  • forms
  • hr
  • inventory
  • orders
  • payments
  • promotions
  • quotes
  • selling_plans
  • shipping
  • subscriptions
  • website