Skip to content
Facteur

Three sets of documentation, and which one to open

The help centre, the API reference and the integration guides each answer a different question. The help centre is on this site, the reference and the guides on the developers' portal.

I want to…

If you know what you want to do but not where it is written, start here. And if your need is missing from the list, write to us: it is a page we still have to write.

I want to… It is written in
receive a message in my tests and read the code it holds
know where the packages for Playwright, Cypress and Node stand
know the exact fields of a response, or what an error code means
create an API key and send it with my requests
understand a quota I reached, or how long my messages are kept
invite a colleague, or separate a workspace
move a test suite written for another service
know what it costs, and from what volume
know where my data is and what the processing agreement commits to
see a test email arrive, without creating an account

What is translated, and what is not

  • All three sets exist in French and in English. Pick yours at the top of the page.

  • What you read is translated, what you type never is. A field name, a path such as /inboxes, an error code such as CRITERIA_UNKNOWN are written in English in both versions: that is what the API expects, and what it returns.

  • The sentence that comes with an API refusal, the detail field, is in English whatever your language. Branch your tests on the code field, never on that sentence: the code does not change, the sentence may be rewritten.

Read, or try it right away

A key, an inbox and a first message: the free plan asks for no credit card.