Changelog
What changed in the API and its webhooks, newest first. Version 1 only ever gains things; anything that would break an integration comes as a new version, with notice. Follow it in a feed reader with the Atom feed.
Webhook tools and clearer failures
- A webhook's signing secret can be changed without missing a delivery: the new secret is created first, test sends use it, and deliveries switch to it when you finish. The examples accept both secrets during the change.
- The console's request log shows the error code and message of every failed call, so you can see why it failed without making it again.
- The account owner is emailed when a webhook starts failing (after six failed attempts in a row, at most once a day), and again if it is switched off, each time with a link to the console.
- The console can send a webhook a test delivery. It carries your newest real record of the event (a sample when there is none yet) and an
X-Webkio-Test: 1header. - A delivery your endpoint already accepted with a 2xx answer is never sent again, even when something fails on our side afterwards.
- Webhooks can be paused and resumed from the console. A paused webhook receives nothing, and events that happen meanwhile are not sent later.
- A webhook switched off after repeated failed deliveries can be turned on again from the console, and one you added yourself can have its signing secret rotated.
- Code examples, a webhooks guide with signature checks in three languages, and an example payload for every event.
See: Webhooks · Examples · Console · API reference
The Webkio API, version 1
- API keys, and
/me,/projectsand/event-types(with the newest records of each event as samples). - Webhooks for new orders, paid orders, bookings, rental reservations, subscribers, property enquiries and product reviews, subscribed with
/webhooks. - Actions: create or update a contact, add an email subscriber, list email lists, create a blog post draft, and find orders.
- Cursor pagination, ISO 8601 UTC timestamps with the timezone to read local dates in, and stable error codes.
- Deliveries signed with HMAC-SHA256 and retried for about half an hour.
See: API reference · Guide · Integrations