Integration
Frequently asked questions
What usually blocks an integration in its first hour.
I lost the token. Can I recover it?
No. What is stored is its sha256. Make another, and remember that generating revokes the previous one: if a script was using the old token, it stops working right away.
Why does creation ask for `tenantId` every time?
Because the workspace is the isolation boundary, and it is immutable: chosen at creation, it never changes again. The only creation that does not ask is the epic's, which inherits the project's workspace.
I sent a valid `columnId` and got 422
The column probably belongs to another set. With columnScope: PROJECT, a card with a project uses that project's columns, not the workspace's. Ask GET /api/columns?tenant=…&project=… to get exactly the set in effect.
The due date shows up a day early or late
dueAtZone was missing. The instant alone does not say the day: the zone the date was declared in answers that, and it travels with the card.
`favorite` comes back different for each person
That is the correct behaviour. The favourite is personal: the mark is a row between the account and the card, and the field is the answer for whoever asked.
A batch failed. How many cards changed?
None. A batch operation refuses as a whole: either all change, or none does. Fix the body and retry freely.
How do I write a history entry?
You do not. History is written by the server, in the same transaction that changes the column. There is no write route: history cannot be edited.
Is there a `GET /api/backup/export`?
No. Exporting is a job: schedule it with POST /api/backup/job, follow it with the GET of the same route and download it with GET /api/backup/file.
How do I paginate?
You do not. Listings return the whole set of the requested filter, and the filter that exists is the workspace, applied on the server.
I keep getting 429 in a load script
The default limit is 300 requests per minute per IP, configurable through NOTEBUGS_RATE_LIMIT. The response carries Retry-After in seconds: honour it instead of retrying in a tight loop.