Skip to main content

Authentication

To communicate with the Riverr GraphQL API, you must authenticate your requests using your API key.

Obtaining your API key​

You can obtain your API key (x-uid) by following these steps:

  1. Log in to your Riverr account.
  2. Open Settings.
  3. Scroll to Developer → API credentials.
  4. Confirm it is you (Google or password), then copy the key.

New keys are a dedicated rv_live_… value. If you already integrated with your Riverr User ID as x-uid, that still works — you do not need to change it. Prefer the rv_live_… key for new integrations.

Rotating the key replaces the current rv_live_… value only. The original User ID remains valid.

Using the API key​

Include the API key in the header of your GraphQL requests as x-uid.

{
  "x-uid": "YOUR_API_KEY_HERE"
}

You must also send Content-Type: application/json on every request.

To receive order, batch, item, and invoice events at your own URL, see Webhooks.