A REST API and webhooks for your mail and your workspace

Connect One Bit Mail to your own scripts and tools. Tokens never reach further than the person who created them, and every message sent through the API follows the same rules as the app.

Settings in the app, with Profile, Password, Signature, Notifications, Install app and API tokens

What it does

  • Personal tokens

    A token reaches only the mailboxes you can open, or fewer if you choose, and only what its scopes allow: list mailboxes, read mail, write drafts, send mail.

  • Admin tokens

    Admins create tokens that manage users, shared mailboxes, forwarding and domains, and read the plan and its usage. An admin token can never read mail.

  • Same rules as the app

    Every message sent through the API goes through the same sending limits, reviews and attachment checks as the app.

  • Webhooks

    Get an event when mail arrives in a mailbox or a message is sent. Events carry details such as the sender and subject, never the message body.

  • Signed and retried

    Each event is signed with a secret you can rotate, in the Standard Webhooks format, and retried with backoff for up to 3 days.

  • Tokens you control

    Tokens expire after at most a year, show their recent activity and can be revoked at once. Revoking a token turns off its webhooks.

How it works

  1. 1

    Create a token

    Open Settings → API tokens, choose the scopes, the mailboxes and when it expires. Copy the token: it is shown once.

  2. 2

    Call the API

    Send requests to https://app.onebitmail.com/api/v1 with the header Authorization: Bearer and your token.

  3. 3

    Subscribe to events

    Register an HTTPS endpoint for webhooks, and check each event's signature with the endpoint's secret.

Questions, answered

More answers are in the help center, or write to support@onebitmail.com.

Who can create API tokens?

Any user can create personal tokens for the mailboxes they can open. Only admins can create admin tokens.

Can an admin token read mail?

No. Admin tokens manage the workspace and never reach mail, just like the Admin console. Create a personal token for mail.

Does mail sent through the API count toward sending limits?

Yes. The API uses the same sending limits, reviews and checks as the app, and each token also has a sending cap of its own.

What happens when I revoke a token?

Anything using it stops working at once, and its webhooks are turned off. This can't be undone.

Start free,
add your team when you are ready

Every request is reviewed by hand. Approved workspaces start on the free plan.

Request access