Guide

Step 1: Get Your Credentials

After signing in to Signal shoot, go to the Settings page. Your App ID and Ingest URL are always visible there. Your API keys (live and test) are only displayed once — at your first sign-in or immediately after regeneration. If you do not see your keys, click Regenerate in Settings. You need three values:

Endpoint: https://api.signalshoot.com/v1/ingest/YOUR_APP_ID
Header: X-API-Key: YOUR_API_KEY

In all code examples below, replace YOUR_APP_ID with your actual App ID and YOUR_API_KEY with your actual key. Use the test key during development and the live key in production. App ID is always visible in Settings. If your API keys are not visible, click Regenerate to create new ones — Signal shoot displays them only once.

Step 2: Understand the Request Format

When your app sends feedback to Signal shoot, it sends a JSON object. Here is what each field does:

For detailed specs (character limits, validation, usage examples), see the API Reference tab.

Step 3: Add the Code to Your App

Choose your platform below and copy the code. The integration is a single HTTP POST request — no library or SDK to install. Paste the code into your app wherever you want users to be able to send feedback (a contact form, a bug report button, a feedback modal, etc.).

One-way feedback：sample code for receive-only integration

React Native / Expo

const sendFeedback = async (type, message, channel = 'contact') => {
  await fetch('https://api.signalshoot.com/v1/ingest/YOUR_APP_ID', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      type, message, channel,
      metadata: { app_version: Constants.expoConfig?.version, os: Platform.OS },
    }),
  });
};

Flutter (Dart)

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<void> sendFeedback(String type, String message) async {
  await http.post(
    Uri.parse('https://api.signalshoot.com/v1/ingest/YOUR_APP_ID'),
    headers: {'Content-Type': 'application/json', 'X-API-Key': 'YOUR_API_KEY'},
    body: jsonEncode({'type': type, 'message': message, 'channel': 'contact'}),
  );
}

Swift (iOS)

func sendFeedback(type: String, message: String) async throws {
    var req = URLRequest(url: URL(string: "https://api.signalshoot.com/v1/ingest/YOUR_APP_ID")!)
    req.httpMethod = "POST"
    req.setValue("application/json", forHTTPHeaderField: "Content-Type")
    req.setValue("YOUR_API_KEY", forHTTPHeaderField: "X-API-Key")
    req.httpBody = try JSONSerialization.data(withJSONObject: [
        "type": type, "message": message, "channel": "contact"
    ])
    let (_, _) = try await URLSession.shared.data(for: req)
}

Kotlin (Android)

val body = JSONObject().apply {
    put("type", "bug"); put("message", msg); put("channel", "contact")
}.toString().toRequestBody("application/json".toMediaType())

val request = Request.Builder()
    .url("https://api.signalshoot.com/v1/ingest/YOUR_APP_ID")
    .addHeader("X-API-Key", "YOUR_API_KEY")
    .post(body).build()

OkHttpClient().newCall(request).execute()

Web (JavaScript)

await fetch('https://api.signalshoot.com/v1/ingest/YOUR_APP_ID', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-API-Key': 'YOUR_API_KEY' },
  body: JSON.stringify({ type: 'bug', message: msg, channel: 'contact' }),
});

Important for web apps: live and test keys (fb_live_*, fb_test_*) must never appear in client-side JavaScript — anyone can open DevTools and copy them. For browser-only ingest, use a publishable key (fb_pub_*) issued from Settings, which is safe to ship to the browser because it is write-only, gated by an Origin allowlist, and rate-limited per source IP. If your integration needs user_id or parent_id (replies, threaded conversations, user-data deletion), publishable keys cannot be used; route those calls through your own backend with a live key.

Step 5: Verify the API Connection Before Going Live

Once your integration is ready, try it out. Send a real message from your app or service and confirm it arrives. Using a test key (fb_test_...) marks the feedback as test data, which you can show or hide in the inbox using the filter toggle. Steps: (1) Send a request with your test API key (fb_test_...) from cURL, Postman, or your app's test environment. (2) Open the dashboard inbox and enable the "Test data" toggle to confirm arrival. (3) Try changing the status, adding tags, and writing a reply. (4) If you implemented replies, verify your app can fetch them. (5) Once reception and replies work correctly, switch from the test API key to the live API key.

curl -X POST https://api.signalshoot.com/v1/ingest/YOUR_APP_ID \
  -H "Content-Type: application/json" \
  -H "X-API-Key: fb_test_YOUR_KEY" \
  -d '{"type":"bug","channel":"contact","message":"Test from cURL"}'

Using a test key lets you verify under production-equivalent conditions. Test keys expire 1 hour after generation. Test submissions do not count toward your monthly feedback limit.

Alternative: Let AI Write the Code for You

You can also let an AI coding assistant handle the setup. See the "AI Setup" tab for details.