Managing webhooks in your admin

What Webhooks Do

A webhook sends an HTTP request to a URL you choose whenever something happens in your store, such as a new order. Open Webhooks in the Settings section of the admin sidebar to manage them. Webhooks are available on plans that include them; you can check your plan under Billing. Developers can find the technical details in the Webhooks guide.

Adding a Webhook

Click Add Webhook, enter the endpoint URL and pick the topics you want delivered to it. The URL has to answer with a success status (2xx) within 10 seconds, and it must not redirect: a redirect counts as a failed delivery, so use the final URL.

Status of a Webhook

• Active: deliveries are going through.
• Failing: recent deliveries failed. The last error is shown under the status, so you can see what your endpoint answered.
• Disabled: the webhook failed 5 times in a row over at least an hour, so Cartly switched it off. A short outage of your endpoint does not do this. Events that happen while a webhook is disabled are not sent to it later.

Send Test

Click Send test to send one test event to the endpoint right now. It is signed like a real delivery and is not retried. Send test and Retry wait up to 30 seconds for an answer, while live deliveries wait 10 seconds, so an endpoint that is slow can pass Send test and still time out on live deliveries. If your endpoint accepts it, the webhook is Active again, which is also how you switch a disabled webhook back on after fixing the endpoint. On a disabled webhook the button reads Send test & re-enable.

Failed Deliveries

Every delivery your endpoint did not accept is kept in the Dead Letter Queue below the webhook list, with the webhook URL, the topic, the error, when it failed and how many attempts were made. For each one you can:

• Retry: send it again now. A successful retry removes it from the list and re-enables a disabled webhook.
• Discard: remove it without sending it again.
• Retry All: retry the failed deliveries on the current page one at a time. Any that fail again stay in the list.

The list is split into pages when there are many failed deliveries.

Deleting a Webhook

Deleting a webhook stops its deliveries immediately. When you uninstall an app, the webhooks it created stop as well; see Installing Apps.