Glossary
Ingest key
An ingest key is the credential a website uses to publish its own events to OneLifeVibe. The world comes from the key, never from the request body.
Updated November 13, 2026
- Also called
website ingest key
At OneLifeVibe
- Each website in the network can publish its own events with POST /api/platform/v1/ingest, authenticated with that website's ingest key, never a client key. The world is taken from the key, so a website can never publish as another.
- POST /api/platform/v1/ingest without the world's own ingest key as a bearer token. Client keys (olvp_…) never work for ingest.
- Ingest is for the network's own websites: each uses its own ingest key, and the world is taken from the key, so a world can never publish as another.
Related terms
What it means
An ingest key is a website's credential for publishing that website's events. It identifies the publisher and ties the write to one world. You do not pass a world in the body and hope the server picks it up. OneLifeVibe reads the world from the key itself. That is the point: the credential decides who is publishing, not the payload. That is on purpose. OneLifeVibe also calls it a website ingest key. It is separate from a client key, and a client key is not an ingest credential.
How it works
Send a POST request to /api/platform/v1/ingest. Put that website's ingest key on the request as a bearer token. The endpoint uses the key to determine the world. The key decides. There is no body field that lets a website publish as another. Client keys (olvp_…) never work for ingest. They are not a substitute when the ingest key is missing. The key belongs to the website, so that website's event posts use it.
How OneLifeVibe uses it
Every website in the network can publish its own events with POST /api/platform/v1/ingest. Each website uses its own ingest key. OneLifeVibe takes the world from that key, so a website can never publish as another. Ingest is for the network's own websites.
Common mistakes
A common mistake is sending a client key. Client keys (olvp_…) never work for ingest. Another is putting a world identifier in the body and expecting it to choose the publisher. The world comes from the ingest key, so the body cannot reassign it. Using a key that belongs to a different website is also wrong. The key's world is the publisher, and a website cannot publish as another. The key sets the publishing world. Check the bearer token too. The endpoint expects the world's own ingest key as a bearer token.
Questions
What is the difference between an ingest key and a client key?
An ingest key authenticates event publishing for one website, while client keys (olvp_…) never work for ingest. Use the website's own ingest key as a bearer token on POST /api/platform/v1/ingest.
How does OneLifeVibe know which world is publishing?
It takes the world from the ingest key. The request body does not choose the world: the key does. That is why a website can never publish as another.
See it working. The OneLifeVibe connector and Platform API put these pieces together.
Written from the OneLifeVibe tool registry and platform configuration, and checked automatically before publishing. Something wrong? Tell us.