Webhooks

A webhook notifies your system as soon as something changes in your Ciklik store: a subscription, an order, a shipment, a customer, a marketing opt-in. You provide a receiving URL for each event type. Ciklik sends the information there the moment it happens, without you having to poll anything.

How to enable it

Pick the event key in the catalogue below. Send that key and your receiving URL to the Ciklik team, or register them yourself through the API. Delivery becomes active in under a minute.

See Enable and test a webhook and Configure webhooks through the API.

What it is for

• Keep your store in sync with an ERP or a PrestaShop site, with no manual re-entry.
• Feed a spreadsheet or a no-code tool such as Make or Zapier.
• Alert your logistics team as soon as a new shipment is created.
• Trigger a custom e-mail from a tool outside Ciklik.

The 18 available events

Object	Key	When it fires
Subscription	created_subscription	a subscription is created
Subscription	updated_subscription	a subscription is updated
Subscription	deleted_subscription	a subscription is deleted
Shipment	created_shippingbox	a shipment is created
Shipment	updated_shippingbox	a shipment is updated
Shipment	deleted_shippingbox	a shipment is deleted
Order	created_checkoutorder	an order is created
Order	updated_checkoutorder	an order is updated
Transaction	created_checkouttransaction	a transaction is created
Transaction	updated_checkouttransaction	a transaction is updated
Invoice	created_checkoutinvoice	an invoice is issued
Customer	created_user	a customer is created
Customer	updated_user	a customer is updated
Address	created_address	an address is created
Address	updated_address	an address is updated
Marketing opt-in	created_optin	a marketing opt-in is created
Marketing opt-in	updated_optin	a marketing opt-in is updated
Subscription	updated_change_choices	on request the customer changes their product choices

updated_change_choices is enabled on request from the Ciklik team, not through the API.

Where to start

Enable and test The step-by-step procedure, with a first test delivery.

Understand a delivery The technical contract, for your developer.

Event reference Each key in detail, with a sample payload.

Best practices and troubleshooting Expected response, retries, security, diagnostics.

OpenAPI contract The machine-readable contract.

Not to be confused with

Mechanism	Where it is configured	What it sends	Page
Site webhooks (this section)	Ciklik team or vendors API	The events of your store: subscriptions, orders, shipments, customers…	this page
Abandoned cart reminder	My Sites, Marketing settings tab	The contact details of an abandoned cart and a recovery link	Abandoned carts
Newsletter block of the editor	Newsletter block settings, on your site	The e-mail address of a new newsletter subscriber	Retrieve newsletter subscribers
Anti-churn campaign	My Sites, Webhook section of the campaign	A notification about a subscriber whose payment failed	Anti-churn campaign

These last three have a format and a lifecycle that have nothing in common with site webhooks.

Personal data

A delivery payload contains your customers’ contact details: name, address, phone number, e-mail. Use HTTPS. Your receiving URL is the only secret in the setup: keep it confidential and share it only with the systems that need it.