Skip to content

Set up webhooks

Webhooks send real-time notifications to an endpoint you control whenever selected events happen in your FlyCommerce store, such as a product update or a shipment. Store owners and marketplace admins set up webhooks from the admin dashboard.

  1. In the admin sidebar, select Integrations, then select Manage on the Webhooks card.
  2. If you have not added a webhook yet, the page shows “Let’s add your first webhook.” Select Add Webhook.

FlyCommerce Webhooks page with the empty state message and Add Webhook button

The Webhooks page shows this message until you add your first webhook.

  1. In the Add Webhook dialog, enter the URL that should receive events in Endpoint. The field shows a placeholder such as https://example.com/webhook.

Add Webhook dialog with Endpoint, Description (Optional), and Events fields

The Add Webhook dialog collects the endpoint, an optional description, and the events to send.

  1. Optionally, enter a note in Description (Optional) so you can tell this webhook apart from others.
  2. Open Events and select the events you want this webhook to receive. The list is searchable and grouped by resource, such as PRODUCT, CATEGORY, and ORDER.

Events dropdown with available events grouped by product, category, collection, brand, and order

The Events dropdown groups events by resource. Select only the events your system needs.

  1. Select Add to save the webhook, or select Cancel to discard it.

FlyCommerce offers 20 events across the product, category, collection, brand, and order resources. Subscribe to the events your system needs and no more.

EventWhen it fires
product.createdA product is created.
product.updatedA product is updated.
product.deletedA product is deleted.
category.createdA category is created.
category.updatedA category is updated.
category.deletedA category is deleted.
collection.createdA collection is created.
collection.updatedA collection is updated.
collection.deletedA collection is deleted.
brand.createdA brand is created.
brand.updatedA brand is updated.
brand.deletedA brand is deleted.
order.createdAn order is created.
order.updatedAn order is updated.
order.deletedAn order is deleted.
order.canceledAn order is canceled.
order.completedAn order is completed.
order.refund.createdA refund is created for an order.
order.shipment.createdA shipment is created for an order.
order.shipment.updatedA shipment for an order is updated.

On the Webhooks page, search for a webhook with the Search Webhook… box, or select Filter to narrow the list.

  • Use an HTTPS endpoint you control.
  • Subscribe only to the events you need. Each extra event adds traffic your endpoint must handle.
  • Respond quickly, then process the work asynchronously, so slow processing does not delay the response.
  • Make your handling idempotent (safe to repeat). The same event may be delivered more than once, so receiving it again should not create duplicate records or changes.