Docs

API keys, apps and webhooks

Connect your own software with API keys, manage the apps members have approved, send events to your systems, and embed flipbooks with a script.

Version 1 · checked on

  1. API keys

    Where: Settings › API keys › New key

    When your plan includes API access, Owners and Admins make API keys for the public API. Name the key, choose when it expires (from 30 days to two years, or never) and give it only the permissions the job needs, from those you hold yourself.

    The key is shown once: copy it into your own system's secret store. Nobody, including Flipbird, can show it again.

    A key acts for the member who made it and can never do more than their role allows now. It stops working if they are removed or deactivated. Rotate replaces the secret straight away with the same name and permissions; Revoke stops the key at once.

  2. Connected apps and assistants

    Where: Settings › Connected apps

    Apps and AI assistants connect with OAuth instead of a key: the app opens your browser, you sign in, and you see what it asks to do and where it sends you back to before choosing Allow access. The name it shows is the one the app gave itself, so check that address is where you started. It can never do more than your role allows.

    Connected apps lists every app a member of the workspace has approved, for Owners and Admins when your plan includes MCP, and Disconnect stops one at once. Each member sees and disconnects their own under Your account.

  3. Webhooks

    Where: Settings › Webhooks › New endpoint

    Webhooks tell your systems when something happens: a document is processed, an export completes, a lead form is submitted, links are clicked (gathered at most hourly), credits run low, an invoice is paid, or a payment fails. Owners and Admins add up to 10 endpoints, each with the events it wants.

    An endpoint must be an https address on the public internet. Each delivery is signed with the endpoint's signing secret, shown once, following the Standard Webhooks scheme; Rotate secret signs with both secrets for 24 hours so you can switch over.

    A delivery succeeds when your endpoint answers with a 2xx status within 10 seconds. Failed deliveries are tried 8 times over about 9 hours, then marked dead. Deliveries shows the last 50 for an endpoint, and Redeliver sends one again.

  4. The embed script

    Where: Documents › Your document › Publish

    Besides the embed code on a document's Publish tab, a page can load Flipbird's embed script from view.flipbird.io/embed.js and place a flipbook by its address's id. The script tells your page when the book is ready, when the reader turns a page or follows a link, and when a lead form is sent, and lets your page turn to a page or search the book.