Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

Outgoing webhooks: how it works

A webhook is a message the system posts to an address of yours the moment something happens, such as a new lead, an invoice sent, a payment received or an order placed. Another system can then react at once instead of asking again and again.

Lesson 3 of 9 · How it works

  • about 3 min
  • System → Integrations → Integrations & API

How it works

  1. On «System → Integrations → Integrations & API», press «Add endpoint» in the «Webhook endpoints» panel. Enter a name and the address, then tick «All events» or pick single events from the list.

  2. After saving, the «Webhook signing secret» is shown once. Copy it into the receiving system, which uses it to check that a post really comes from your site.

  3. When a subscribed event happens, the system posts the details to the address straight away. The receiver must answer with success within 10 seconds.

  4. A post that fails is tried again after 1 minute, 5 minutes, 30 minutes, 2 hours, 12 hours and 24 hours. After that it is marked failed.

  5. An endpoint that fails 25 times in a row Is switched off This part of the admin was switched off because the business does not use it. It is hidden from the menu and its pages are closed. More words in the glossary by the system, and the dashboard shows a to-do. Press «Enable» on its row once the receiver works again.

  6. «Test» on the row, or «Send test event» on the endpoint page, posts a test message. The endpoint page also shows its recent deliveries and lets you replace the secret with «Rotate secret».

  7. «Delivery log» lists every post with its status, endpoint and event, the content that was sent and the answer received. «Retry now» sends a failed one again. Rows are kept for 30 days.

Where to find it

Settings that change it

Checklist

Before you move on, check that you can:

  • Open System → Integrations → Integrations & API
  • On System → Integrations → Integrations & API, press Add endpoint in the Webhook endpoints panel.
  • After saving, the Webhook signing secret is shown once.
  • When a subscribed event happens, the system posts the details to the address straight away.
  • A post that fails is tried again after 1 minute, 5 minutes, 30 minutes, 2 hours, 12 hours and 24 hours.

Tips and common mistakes

  • Nothing arrives? Open the delivery log and read the answer on the failed row. A wrong address or a receiver that takes longer than 10 seconds are the usual causes.
  • The same post may arrive more than once after a retry. The receiving system should use the delivery ID to ignore repeats.
  • After «Rotate secret» the very next post is signed with the new secret, so update the receiving system at the same moment.
  • Retries are sent by the background worker. While it is stopped, failed posts are not tried again.