Getting started

Treads.nz lets you connect your own tools to your account two ways: a personal API key for reading/writing your own data, and webhooks for getting notified the moment something happens on your account, without polling.

1. Generate an API key

1. Go to Account → API & Webhooks (you'll need to be logged in).
2. Under API Keys, give your key a name (e.g. "Zapier integration" or "My inventory script") so you can tell it apart from any others later.
3. Choose how long it should last - 1 month, 6 months, 1 year, or never expire.
4. Click Generate. Your full key is shown once, right there on the page - copy it somewhere safe immediately. We only ever store a one-way hash of it, so if you lose it, you'll need to revoke it and generate a new one.

Every key looks like this - a fixed treads_ prefix followed by 64 hex characters:

treads_4a7f9b2c1e8d3f6a0b5c7d9e2f4a6b8c1d3e5f7a9b0c2d4e6f8a0b1c3d5e7f9a

Keep it secret - anyone with your key can act as you against the API. If a key is ever exposed (committed to a public repo, pasted somewhere it shouldn't be), revoke it immediately from the API & Webhooks page and generate a replacement.

2. Set up a webhook

1. On the same Account → API & Webhooks page, switch to the Webhooks tab.
2. Give it a name and the URL on your own server that should receive events.
3. Tick which events you want to be notified about (e.g. photo.uploaded, status.updated).
4. Click Add webhook. You'll be shown a signing secret once - save it, since you'll need it to verify that deliveries genuinely came from Treads.nz. See the Webhooks reference for exactly how.

That's it - once wired up, your endpoint will start receiving signed batches of events as they happen. Head to Webhooks for the payload format, or REST API for what's coming on the API side.