Pushing records in from another system

Create and manage API keys for the Inbound API. API keys let external systems (website forms, integrations, scripts) push records directly into your streams.

Creating an API key

  1. 1

    Click "New Key" and enter a name for the key (e.g. "Website Form" or "Zapier").

  2. 2

    Click Create. The full key is shown once - copy it immediately.

  3. 3

    The key cannot be viewed again after you leave the page.

Using the Inbound API

  1. 1

    Send a POST request to /api/inbound/{streamId} with your API key in the X-API-Key header.

  2. 2

    The JSON body must include entityType (string) and fields (object mapping field names to values).

  3. 3

    Records are created at the first step of the stream. Entity types are auto-created if they don't exist.

  4. 4

    Field names must match the fields defined in your stream settings. Unknown fields are ignored.

Revoking a key

  1. 1

    Click the delete icon next to the key you want to revoke.

  2. 2

    Revoked keys stop working immediately and cannot be restored.

What people ask about this

  • How do I create an API key?
  • How do I send data to Streams from my website?
  • What does the Inbound API request body look like?
  • How do I revoke an API key?

Inside the app there is an assistant that answers these from your own written process, not just from ours.

Other guides

All guides

Start with the free plan

Two users, 500 records and every feature switched on. No credit card, and your data stays in Australia.

Get started free