Skip to content
API, security & troubleshooting

Prepare a useful support report

Share enough context to reproduce a problem without exposing customer data or credentials.

Where to find itHelp center / your available support channel

Before you begin

Use a test environment and the smallest necessary access. Keep workspace API keys and signing secrets on your server, outside browser code and public screenshots.

Example workspace · Demo data. Read the conversation, review staff control and choose the next action. Select the image to enlarge it.
Inbox conversation with staff controls, reply composer and contact context

Example workspace · Demo data. Read the conversation, review staff control and choose the next action. Select the image to enlarge it.

Step by step

  1. 1

    Describe the expected result

    State the action you took, the actual result and what you expected instead. Include the affected feature and approximate time.

  2. 2

    Identify the scope safely

    Record the workspace/agent identifiers needed by your authorised support process. Redact messages, contact details, API keys and payment information from screenshots.

  3. 3

    Add a minimal reproduction

    Use harmless test data and list the smallest steps. Mention browser, operating system and whether it happens in a clean visitor context.

  4. 4

    Include evidence

    Copy the exact non-sensitive error and whether the issue affects one agent, one user or the whole workspace. Use the support channel offered by your account or Corthex website.

Good to know

Do not post private customer conversations in a public issue. This help center does not submit a support ticket when you use article feedback.

Check the result

Check the response, relevant delivery history and organisation scope. Use the Public REST API reference in this Help Center for the technical contract.

Questions & troubleshooting

Where are the exact API schemas?

Open the Public REST API reference in this Help Center. The same search covers task guidance, request fields, limits and the technical contract.

Was this article helpful?

Rate this guide on this device. Ratings are not sent to Corthex.