Feedback API

Submit in-app product feedback from the dashboard Feedback dialog Base path: /api/v1/feedback Endpoint count: 1

title: “Deliver feedback from the dialog” description: “What happens when the dashboard Feedback dialog posts here, and what the delivery confirmation tells the caller.”

Deliver feedback from the dialog

The dashboard’s Feedback dialog posts every in-app product note here. The dialog’s three categories (idea, issue, other) and free-text message travel as JSON, and two optional fields carry the reading context: pagePath (the screen the customer was on) and locale (the active dashboard language). Your API key identifies the submitter; the endpoint resolves their name and organization so the reply routed to the Devotel feedback inbox reads as a person, not an anonymous log line. The message is dispatched as a transactional email with the submitter’s address set as reply-to, and the response carries a delivered flag so the dialog renders the right confirmation.

{
  "data": {
    "delivered": true
  },
  "meta": {
    "request_id": "req_feedback",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

delivered: false means transactional email is not configured on the account — the dashboard falls back to a copy / mail-client hand-off instead of claiming a delivery that never happened. Either way the same [ data, meta ] envelope holds.

Submit product feedback

POST /api/v1/feedback

Deliver in-app product feedback from the dashboard Feedback dialog. The authenticated submitter’s message is dispatched as a transactional email to the Devotel feedback inbox (with the submitter’s address set as reply-to) and a delivery confirmation is returned. Body: category (idea | issue | other), message, and optional pagePath + locale. Responds { delivered: true } when the email was sent (or durably queued for retry) and { delivered: false } when transactional email is not configured, so the dashboard can fall back to its copy / mailto hand-off.

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

string (enum: idea|issue|other)

required

Feedback category shown in the dialog’s selector — idea for a suggestion, issue for something not working, or other for general feedback.

string

required

The free-text feedback message (1–4000 characters).

string

Dashboard page the feedback was sent from (e.g. /contacts), up to 512 characters. Included as context in the feedback email.

string

Active dashboard locale (e.g. en), up to 32 characters. Included as context in the feedback email.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/feedback" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/feedback', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/feedback", headers=headers, json={
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/feedback", bytes.NewBuffer([]byte(`{
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/feedback')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/feedback');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "category": "idea",
  "message": "It would be great to bulk-export contacts as CSV.",
  "pagePath": "/contacts",
  "locale": "en"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "delivered": true
  },
  "meta": {
    "request_id": "req_feedback",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Feedback API

Feedback API

title: “Deliver feedback from the dialog” description: “What happens when the dashboard Feedback dialog posts here, and what the delivery confirmation tells the caller.”

Deliver feedback from the dialog

Submit product feedback

​Feedback API

​title: “Deliver feedback from the dialog” description: “What happens when the dashboard Feedback dialog posts here, and what the delivery confirmation tells the caller.”

​Deliver feedback from the dialog

​Submit product feedback

Feedback API

title: “Deliver feedback from the dialog” description: “What happens when the dashboard Feedback dialog posts here, and what the delivery confirmation tells the caller.”

Deliver feedback from the dialog

Submit product feedback