> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # List webhook events > Returns every event a webhook endpoint can subscribe to, including those installed extensions declare. Credential events reach only endpoints that name them, and subscribing to one needs the permission listed; deprecated events name their replacement. ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/webhook_events openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/webhook_events: get: tags: - Webhooks summary: List webhook events description: >- Returns every event a webhook endpoint can subscribe to, including those installed extensions declare. Credential events reach only endpoints that name them, and subscribing to one needs the permission listed; deprecated events name their replacement. parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string responses: '200': description: events returned content: application/json: example: data: - name: admin_user.password_reset group: admin_user credential_permission: null credential: false deprecated: false replaced_by: null - name: cart.created group: cart credential_permission: null credential: false deprecated: false replaced_by: null - name: cart.deleted group: cart credential_permission: null credential: false deprecated: false replaced_by: null - name: cart.updated group: cart credential_permission: null credential: false deprecated: false replaced_by: null - name: catalog.created group: catalog credential_permission: null credential: false deprecated: false replaced_by: null - name: catalog.deleted group: catalog credential_permission: null credential: false deprecated: false replaced_by: null - name: catalog.updated group: catalog credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.approved group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.canceled group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.created group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.deleted group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.denied group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.opened group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.resolved group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: claim.updated group: claim credential_permission: null credential: false deprecated: false replaced_by: null - name: company.created group: company credential_permission: null credential: false deprecated: false replaced_by: null - name: company.deleted group: company credential_permission: null credential: false deprecated: false replaced_by: null - name: company.updated group: company credential_permission: null credential: false deprecated: false replaced_by: null - name: company_invitation.accepted group: company_invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: company_invitation.created group: company_invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: company_invitation.deleted group: company_invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: company_invitation.revoked group: company_invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: company_invitation.updated group: company_invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: customer.anonymized group: customer credential_permission: null credential: false deprecated: false replaced_by: null - name: customer.password_reset group: customer credential_permission: null credential: false deprecated: false replaced_by: null - name: customer.password_reset_requested group: customer credential_permission: write_customers credential: true deprecated: false replaced_by: null - name: data_request.completed group: data_request credential_permission: null credential: false deprecated: false replaced_by: null - name: data_request.confirmation_requested group: data_request credential_permission: write_customers credential: true deprecated: false replaced_by: null - name: data_request.created group: data_request credential_permission: null credential: false deprecated: false replaced_by: null - name: data_request.deleted group: data_request credential_permission: null credential: false deprecated: false replaced_by: null - name: data_request.updated group: data_request credential_permission: null credential: false deprecated: false replaced_by: null - name: delivery.created group: delivery credential_permission: null credential: false deprecated: false replaced_by: null - name: delivery.deleted group: delivery credential_permission: null credential: false deprecated: false replaced_by: null - name: delivery.updated group: delivery credential_permission: null credential: false deprecated: false replaced_by: null - name: digital.created group: digital credential_permission: null credential: false deprecated: true replaced_by: digital_asset.created - name: digital.deleted group: digital credential_permission: null credential: false deprecated: true replaced_by: digital_asset.deleted - name: digital.updated group: digital credential_permission: null credential: false deprecated: true replaced_by: digital_asset.updated - name: digital_asset.created group: digital_asset credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_asset.deleted group: digital_asset credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_asset.updated group: digital_asset credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_link.created group: digital_link credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_link.deleted group: digital_link credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_link.downloaded group: digital_link credential_permission: null credential: false deprecated: false replaced_by: null - name: digital_link.updated group: digital_link credential_permission: null credential: false deprecated: false replaced_by: null - name: email_template.published group: email_template credential_permission: null credential: false deprecated: false replaced_by: null - name: email_template.reverted group: email_template credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.approved group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.canceled group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.created group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.deleted group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.fulfilled group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.received group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.requested group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: exchange.updated group: exchange credential_permission: null credential: false deprecated: false replaced_by: null - name: export.created group: export credential_permission: null credential: false deprecated: false replaced_by: null - name: export.deleted group: export credential_permission: null credential: false deprecated: false replaced_by: null - name: export.updated group: export credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.canceled group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.created group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.deleted group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.delivered group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.fulfilled group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: fulfillment.updated group: fulfillment credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.canceled group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.created group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.deleted group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.partially_redeemed group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.redeemed group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card.updated group: gift_card credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card_batch.created group: gift_card_batch credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card_batch.deleted group: gift_card_batch credential_permission: null credential: false deprecated: false replaced_by: null - name: gift_card_batch.updated group: gift_card_batch credential_permission: null credential: false deprecated: false replaced_by: null - name: import.completed group: import credential_permission: null credential: false deprecated: false replaced_by: null - name: import.created group: import credential_permission: null credential: false deprecated: false replaced_by: null - name: import.deleted group: import credential_permission: null credential: false deprecated: false replaced_by: null - name: import.progress group: import credential_permission: null credential: false deprecated: false replaced_by: null - name: import.updated group: import credential_permission: null credential: false deprecated: false replaced_by: null - name: import_row.completed group: import_row credential_permission: null credential: false deprecated: false replaced_by: null - name: import_row.failed group: import_row credential_permission: null credential: false deprecated: false replaced_by: null - name: invitation.accepted group: invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: invitation.created group: invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: invitation.resent group: invitation credential_permission: null credential: false deprecated: false replaced_by: null - name: line_item.created group: line_item credential_permission: null credential: false deprecated: false replaced_by: null - name: line_item.deleted group: line_item credential_permission: null credential: false deprecated: false replaced_by: null - name: line_item.updated group: line_item credential_permission: null credential: false deprecated: false replaced_by: null - name: media.created group: media credential_permission: null credential: false deprecated: false replaced_by: null - name: media.deleted group: media credential_permission: null credential: false deprecated: false replaced_by: null - name: media.updated group: media credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.created group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.deleted group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.subscription_requested group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.unsubscribe_requested group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.updated group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: newsletter_subscriber.verified group: newsletter_subscriber credential_permission: null credential: false deprecated: false replaced_by: null - name: order.approved group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.canceled group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.completed group: order credential_permission: null credential: false deprecated: true replaced_by: order.placed - name: order.created group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.deleted group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.delivered group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.fulfilled group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.paid group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.placed group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.resend_confirmation_email group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.resend_digital_links_email group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order.shipped group: order credential_permission: null credential: false deprecated: true replaced_by: order.fulfilled - name: order.updated group: order credential_permission: null credential: false deprecated: false replaced_by: null - name: order_group.completed group: order_group credential_permission: null credential: false deprecated: false replaced_by: null - name: order_group.created group: order_group credential_permission: null credential: false deprecated: false replaced_by: null - name: order_group.deleted group: order_group credential_permission: null credential: false deprecated: false replaced_by: null - name: order_group.resend_confirmation_email group: order_group credential_permission: null credential: false deprecated: false replaced_by: null - name: order_group.updated group: order_group credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.captured group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.completed group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.created group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.deleted group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.paid group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.refunded group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.updated group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment.voided group: payment credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.canceled group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.completed group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.created group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.deleted group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.expired group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.failed group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.processing group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_session.updated group: payment_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.canceled group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.completed group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.created group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.deleted group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.expired group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.failed group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.processing group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: payment_setup_session.updated group: payment_setup_session credential_permission: null credential: false deprecated: false replaced_by: null - name: price.created group: price credential_permission: null credential: false deprecated: false replaced_by: null - name: price.deleted group: price credential_permission: null credential: false deprecated: false replaced_by: null - name: price.updated group: price credential_permission: null credential: false deprecated: false replaced_by: null - name: product.activated group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.approved group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.archived group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.back_in_stock group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.created group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.deleted group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.drafted group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.out_of_stock group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.proposed group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.rejected group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product.updated group: product credential_permission: null credential: false deprecated: false replaced_by: null - name: product_submission.created group: product_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: product_submission.deleted group: product_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: product_submission.updated group: product_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: promotion.created group: promotion credential_permission: null credential: false deprecated: false replaced_by: null - name: promotion.deleted group: promotion credential_permission: null credential: false deprecated: false replaced_by: null - name: promotion.updated group: promotion credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.canceled group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.created group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.deleted group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.draft group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.ordered group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.over_received group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.partially_received group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.received group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: purchase_order.updated group: purchase_order credential_permission: null credential: false deprecated: false replaced_by: null - name: refund.created group: refund credential_permission: null credential: false deprecated: false replaced_by: null - name: refund.deleted group: refund credential_permission: null credential: false deprecated: false replaced_by: null - name: refund.updated group: refund credential_permission: null credential: false deprecated: false replaced_by: null - name: return.approved group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.canceled group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.created group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.deleted group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.received group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.refunded group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.requested group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: return.updated group: return credential_permission: null credential: false deprecated: false replaced_by: null - name: saved_report.created group: saved_report credential_permission: null credential: false deprecated: false replaced_by: null - name: saved_report.deleted group: saved_report credential_permission: null credential: false deprecated: false replaced_by: null - name: saved_report.updated group: saved_report credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.approved group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.created group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.deleted group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.invited group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.onboarding_reopened group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.onboarding_started group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.rejected group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.submitted_for_review group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.suspended group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller.updated group: seller credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_payout.completed group: seller_payout credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.accepted group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.created group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.deleted group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.rejected group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.updated group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_requirement_submission.waived group: seller_requirement_submission credential_permission: null credential: false deprecated: false replaced_by: null - name: seller_user.password_reset group: seller_user credential_permission: null credential: false deprecated: false replaced_by: null - name: shipment.canceled group: shipment credential_permission: null credential: false deprecated: true replaced_by: fulfillment.canceled - name: shipment.shipped group: shipment credential_permission: null credential: false deprecated: true replaced_by: fulfillment.fulfilled - name: shipping_label.created group: shipping_label credential_permission: null credential: false deprecated: false replaced_by: null - name: shipping_label.deleted group: shipping_label credential_permission: null credential: false deprecated: false replaced_by: null - name: shipping_label.purchased group: shipping_label credential_permission: null credential: false deprecated: false replaced_by: null - name: shipping_label.refunded group: shipping_label credential_permission: null credential: false deprecated: false replaced_by: null - name: shipping_label.updated group: shipping_label credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_item.created group: stock_item credential_permission: null credential: false deprecated: true replaced_by: stock_level.created - name: stock_item.deleted group: stock_item credential_permission: null credential: false deprecated: true replaced_by: stock_level.deleted - name: stock_item.updated group: stock_item credential_permission: null credential: false deprecated: true replaced_by: stock_level.updated - name: stock_level.created group: stock_level credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_level.deleted group: stock_level credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_level.updated group: stock_level credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_movement.created group: stock_movement credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_movement.deleted group: stock_movement credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_movement.updated group: stock_movement credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_receipt.created group: stock_receipt credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_receipt.deleted group: stock_receipt credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_receipt.updated group: stock_receipt credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_reservation.created group: stock_reservation credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_reservation.deleted group: stock_reservation credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_reservation.updated group: stock_reservation credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.canceled group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.created group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.deleted group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.draft group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.over_received group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.partially_received group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.ready_to_ship group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.received group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.shipped group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: stock_transfer.updated group: stock_transfer credential_permission: null credential: false deprecated: false replaced_by: null - name: store_credit.created group: store_credit credential_permission: null credential: false deprecated: false replaced_by: null - name: store_credit.deleted group: store_credit credential_permission: null credential: false deprecated: false replaced_by: null - name: store_credit.updated group: store_credit credential_permission: null credential: false deprecated: false replaced_by: null - name: supplier.created group: supplier credential_permission: null credential: false deprecated: false replaced_by: null - name: supplier.deleted group: supplier credential_permission: null credential: false deprecated: false replaced_by: null - name: supplier.updated group: supplier credential_permission: null credential: false deprecated: false replaced_by: null - name: tax_exemption_certificate.verified group: tax_exemption_certificate credential_permission: null credential: false deprecated: false replaced_by: null - name: tax_identifier.number_changed group: tax_identifier credential_permission: null credential: false deprecated: false replaced_by: null - name: user.created group: user credential_permission: null credential: false deprecated: false replaced_by: null - name: user.deleted group: user credential_permission: null credential: false deprecated: false replaced_by: null - name: user.updated group: user credential_permission: null credential: false deprecated: false replaced_by: null - name: variant.created group: variant credential_permission: null credential: false deprecated: false replaced_by: null - name: variant.deleted group: variant credential_permission: null credential: false deprecated: false replaced_by: null - name: variant.updated group: variant credential_permission: null credential: false deprecated: false replaced_by: null - name: wished_item.created group: wished_item credential_permission: null credential: false deprecated: true replaced_by: wishlist_item.created - name: wished_item.deleted group: wished_item credential_permission: null credential: false deprecated: true replaced_by: wishlist_item.deleted - name: wished_item.updated group: wished_item credential_permission: null credential: false deprecated: true replaced_by: wishlist_item.updated - name: wishlist.created group: wishlist credential_permission: null credential: false deprecated: false replaced_by: null - name: wishlist.deleted group: wishlist credential_permission: null credential: false deprecated: false replaced_by: null - name: wishlist.updated group: wishlist credential_permission: null credential: false deprecated: false replaced_by: null - name: wishlist_item.created group: wishlist_item credential_permission: null credential: false deprecated: false replaced_by: null - name: wishlist_item.deleted group: wishlist_item credential_permission: null credential: false deprecated: false replaced_by: null - name: wishlist_item.updated group: wishlist_item credential_permission: null credential: false deprecated: false replaced_by: null meta: count: 252 security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const { data: events } = await client.webhookEvents.list() - lang: bash label: Spree CLI source: spree api get /webhook_events components: securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.