Webhook Events

Violet publishes webhook events organized by entity type, making it easy to find and subscribe to the events relevant to your integration.

Entity Types

Select an entity type below to view all available webhook events for that entity:

Order Webhooks

Track the complete order lifecycle including placement, acceptance, shipment, delivery, returns, refunds, and cancellations.

Events: ORDER_ACCEPTED, ORDER_UPDATED, ORDER_COMPLETED, ORDER_SHIPPED, ORDER_DELIVERED, ORDER_REFUNDED, ORDER_RETURNED, ORDER_CANCELLED

Merchant Webhooks

Monitor merchant connections, status changes, and health check updates.

Events: MERCHANT_CONNECTED, MERCHANT_DISCONNECTED, MERCHANT_ENABLED, MERCHANT_DISABLED, MERCHANT_NEEDS_ATTENTION, MERCHANT_COMPLETE

Offer Webhooks

Receive notifications about product offer availability and updates.

Events: OFFER_CREATED (deprecated), OFFER_ADDED, OFFER_UPDATED, OFFER_REMOVED, OFFER_DELETED

Collection Webhooks

Track collection creation, updates, and changes to collection contents.

Events: COLLECTION_CREATED, COLLECTION_UPDATED, COLLECTION_REMOVED, COLLECTION_OFFERS_UPDATED

Sync Webhooks

Get notified about catalog sync operations including start, completion, and failures.

Events: PRODUCT_SYNC_STARTED, PRODUCT_SYNC_COMPLETED, PRODUCT_SYNC_FAILED, COLLECTION_SYNC_STARTED, COLLECTION_SYNC_COMPLETED, COLLECTION_SYNC_FAILED

Payout Account Webhooks

Monitor payout account lifecycle events including creation, requirements, activation, and deletion.

Events: MERCHANT_PAYOUT_ACCOUNT_CREATED, MERCHANT_PAYOUT_ACCOUNT_REQUIREMENTS_UPDATED, MERCHANT_PAYOUT_ACCOUNT_ACTIVATED, MERCHANT_PAYOUT_ACCOUNT_DEACTIVATED, MERCHANT_PAYOUT_ACCOUNT_DELETED

Payment Transaction Webhooks

Track payment capture status changes including authorization, capture, refunds, and failures.

Events: PAYMENT_TRANSACTION_CAPTURE_STATUS_UPDATED, PAYMENT_TRANSACTION_CAPTURE_STATUS_AUTHORIZED, PAYMENT_TRANSACTION_CAPTURE_STATUS_CAPTURED, PAYMENT_TRANSACTION_CAPTURE_STATUS_REFUNDED, PAYMENT_TRANSACTION_CAPTURE_STATUS_PARTIALLY_REFUNDED, PAYMENT_TRANSACTION_CAPTURE_STATUS_FAILED

Transfer Webhooks

Monitor fund transfers to merchants including successful transfers, partial transfers, failures, and reversals.

Events: TRANSFER_SENT, TRANSFER_PARTIALLY_SENT, TRANSFER_FAILED, TRANSFER_UPDATED, TRANSFER_REVERSED, TRANSFER_PARTIALLY_REVERSED, TRANSFER_REVERSAL_FAILED

Webhook Headers

All webhook events include standard headers for security, identification, and filtering:

Default Headers

  • X-Violet-Hmac - Signed HMAC for security validation

  • X-Violet-Topic - Event topic (e.g., ORDER_COMPLETED)

  • X-Violet-Event-Id - Unique event ID for idempotency

  • X-Violet-Entity-Id - Related entity ID

  • X-Violet-Entity-Length - Entity payload size in bytes

  • X-Violet-Webhook-Id - Webhook subscription ID

Additional Headers

Some events include additional context-specific headers:

  • X-Violet-Order-Id - Order ID (order, payment transaction, and transfer events)

  • X-Violet-Bag-Id - Bag ID (order events)

  • X-Violet-Reason - Additional context about why the event triggered (merchant events)

  • X-Violet-Event-Id-Source - Original event ID when resending webhooks

Learn more about webhook headers.

Testing Webhooks

Use the webhook simulation tool to receive real example webhook payloads for testing your integration.

Retrieving Historical Events

Need to access webhook events that were sent in the past? See Retrieving Webhook Events for API methods to fetch historical webhook event data.

Related Documentation

PreviousHandling WebhooksNextOrders

Last updated

Was this helpful?