Skip to content
Log inStart free

Webhooks

A webhook sends your store's event data to an external URL in real time. You create one by choosing an event, a format, and a destination URL, from Settings, Notifications, Webhooks.

Updated
Reading time
3 min
On this page

A webhook lets an external system receive your store's data the moment an event happens, instead of asking for it over and over. You create one by choosing the store event to listen for, the format of the data, and the URL it is sent to. Tanqory then sends the event data to that URL each time the event occurs, and it generates a signing secret you can use to confirm the requests really came from your store. You reach it from Settings, under Notifications, then Webhooks.

What you set for a webhook

Field What it is
Event The store event that triggers the webhook, such as Order creation or Cart creation
Format The format the data is sent in, JSON or XML
URL The endpoint the data is sent to
Webhook API version The version the payload follows, such as 2025-01

Before you begin

  • Your role includes General settings.
  • You have a reachable HTTPS endpoint ready to receive the data.
  • Open Settings, then Notifications, then Webhooks, to create and manage webhooks.

Create a webhook

From the admin, open Settings > Notifications, then Webhooks. The page shows a Create webhook button and, once you have created one, a Webhook signing secret. Before that it reads No webhooks.

Select Create webhook to open the Add webhook dialog. It has four fields: Event, Format, URL, and Webhook API version. Fill them in and select Save to create the webhook.

The Add webhook dialog: the Event, Format, URL, and Webhook API version fields, with Cancel and Save (opens full size)

  • Choose the event. The Event field is a list of the store events you can listen for, such as Cart creation, Order creation, Order fulfilled, Product update, Customer creation, and Refund creation. Choose the single event your integration needs to react to. Subscribe to only the events you actually use, so your endpoint is not sent data it will ignore.
  • Choose the format and enter the URL. Set Format to JSON or XML, matching what your endpoint expects. In URL, enter the address the data is sent to, for example an HTTPS endpoint on your own service. Use an endpoint that is reachable and answers quickly, because the data is delivered to it the moment the event happens.
  • Pick the API version. Webhook API version sets the structure of the data that is sent, here 2025-01. Keep it fixed so your endpoint keeps reading the payload the same way, and change it only when you have updated your endpoint to match a newer version.
  • Save and use the signing secret. Select Save to create the webhook. Once a webhook exists, the Webhook signing secret on the Webhooks page is generated. Use it to verify that incoming requests genuinely came from your store, so a third party cannot send fake events to your endpoint.

Best practices

  • Subscribe to only the events you use. One webhook listens for one event, so add only the events your integration reacts to and avoid unnecessary traffic.
  • Use a reachable HTTPS endpoint. The data is sent the moment an event happens, so the endpoint should be online and answer quickly.
  • Verify requests with the signing secret. Checking the signature confirms the data came from your store rather than an impostor.
  • Keep the API version fixed. Your endpoint expects one payload structure, so change the version only after your endpoint is ready for it.

If something goes wrong

  • Your endpoint is not receiving data. Confirm the URL is correct and the endpoint is reachable and returns a success response.
  • You are not sure a request is genuine. Verify it against the Webhook signing secret before acting on it.
  • You cannot create a webhook. Your role may not allow managing settings. Ask an owner or admin.

Next steps

Still stuck?

More in Store Setup

  • Store Defaults

    Store defaults sets the store-wide values new products, orders, and reports inherit: the default currency, a backup region, the unit system, the default weight unit, and the store timezone.

  • Store Details

    Store details holds your store profile: the store name, contact email, and phone number that appear on your storefront and in customer messages. You edit them in one dialog from Settings, General.

  • Users

    The Users page is where you manage the people who can access your store admin. You see each team member's status and role, add new users, filter by All, Active, Pending, or Requests, and export the list.

  • What to Get Right at Checkout Before You Launch

    The checkout settings that can cost you an order or leave you without something you cannot go back for, worst first, the one thing about this page that catches people out after launch, and the three cards you can safely leave alone.

All 31 articles in Store Setup

We use cookies

Necessary cookies keep the site working. With your permission we also use analytics and marketing cookies. Change your choice any time in Cookie settings.