Troubleshooting Guide
This guide covers the most common issues you may encounter when using Scitor, along with solutions to resolve them.
Emails not arriving as Issues/Discussions
If inbound emails arenโt being converted to GitHub Issues or Discussions, check the following:
-
Email forwarding configuration โ Ensure your email provider is forwarding to the correct Scitor inbound address. Check your forwarding rules are active and not paused.
-
Email forwarding โ Confirm that your email provider is forwarding to the Scitor inbound address provided during setup. Test by sending a message to your support address and checking that it arrives as a GitHub Issue.
-
Blocked sender โ The sender may have been previously blocked. Use
/unblock-senderon any issue to remove a sender from the block list. -
Installation status โ Confirm the Scitor GitHub App is still installed and has access to the target repository. Check your GitHub App installation settings.
-
Spam score โ Emails with a high spam score may be automatically filtered. Check the senderโs email authentication (SPF, DKIM, DMARC).
Tip
Start by checking your GitHub App installation at github.com/settings/installations to verify Scitor has access to the expected repositories.
/send command not working
If the /send command isnโt sending emails:
-
Metadata comment โ Every inbound issue contains a hidden HTML comment with sender metadata. If this comment is edited or deleted,
/sendcannot determine the recipient. Do not modify the issue bodyโs hidden comment block. -
Outbound email limit โ Check whether youโve exceeded your planโs monthly outbound email limit (100 for Free, 500 for Pro). Use
/generate-reportto check your current usage. -
Email provider โ Outbound email requires a configured email provider on Scitorโs side. If
/sendfails and your plan limit isnโt exceeded, contact support so we can check the provider configuration for your account. -
Sender address โ Ensure the configured sender address is valid and verified with your email provider.
Warning
Never edit or delete the hidden HTML metadata comment in the issue body. It contains the senderโs email address and is required for /send to work.
AI triage not labeling tickets
If AI analysis labels (sentiment, category) arenโt being applied:
-
Plan check โ AI triage is a Pro plan feature. Verify your plan is active with
/billing. -
Configuration โ Ensure
ai: trueis set in yourscitor.yamlconfiguration file. -
Content type โ AI analysis requires text content to process. Image-only emails or emails with very little text may not trigger analysis.
Info
AI analysis runs automatically on every inbound email and form submission when enabled. Labels are applied within seconds of the issue being created.
SLA deadlines seem wrong
If SLA response or resolution deadlines donโt match your expectations:
-
Business hours โ Check your business hours configuration in
scitor.yaml. SLA timers only count time during configured business hours. -
Timezone โ Verify the timezone setting in your SLA configuration matches your teamโs working timezone.
-
Waiting on customer โ SLA timers automatically pause when the
waiting-on-customerlabel is applied to an issue. Remove the label to resume the timer. -
Check SLA state โ Use
/slaon any issue to see the current SLA state, including elapsed time and remaining time.
Tip
Use /sla to inspect the full SLA breakdown for any issue, including paused time and business hours applied.
Knowledge base not updating
If your documentation site isnโt reflecting recent changes:
-
Docs folder path โ Ensure the
docsconfiguration inscitor.yamlpoints to the correct folder in your repository. -
Branch โ Only pushes to the default branch trigger a knowledge base rebuild. Changes on feature branches wonโt be published until merged.
-
Build logs โ Check for build errors that may prevent the docs from being published. Look for syntax errors in frontmatter or invalid Markdown.
Warning
Only Markdown (.md) files are supported. Other formats like .html or .rst will be ignored during the docs build.
CSAT surveys not sending
If customer satisfaction surveys arenโt being sent after issues are closed:
-
CSAT enabled โ Verify CSAT surveys are enabled in your
scitor.yamlconfiguration. -
Timing โ Surveys are sent after an issue is closed, with a configurable delay. The survey wonโt send immediately upon closing.
-
Cron schedule โ The CSAT survey job runs on a cron schedule every 5 minutes. There may be a short delay before the survey is dispatched.
-
Duplicate prevention โ Only one survey is sent per issue. If a survey has already been sent for a given issue, it wonโt be sent again.
Info
CSAT surveys are a Pro plan feature. Ensure your subscription is active with /billing.
Custom domain not working
If your custom docs domain isnโt resolving or showing your knowledge base:
-
DNS records โ Verify that the required DNS records (CNAME or A record) are correctly configured with your DNS provider.
-
Domain verification โ Use
/verify-domainto check the current verification status of your domain. -
DNS propagation โ Allow up to 48 hours for DNS changes to propagate globally. Use an online DNS propagation checker to monitor progress.
-
Domain authentication โ Ensure the domain has been authenticated via
/authenticate-domainfor email sending purposes.
Tip
You can check DNS propagation status using tools like dnschecker.org while waiting for changes to take effect.
Form submissions not creating tickets
If web form submissions arenโt being converted to GitHub Issues:
-
Form ID โ Check that the form ID used in the embed code is valid and the form is active.
-
Turnstile CAPTCHA โ If CAPTCHA verification is enabled for the form, ensure the Cloudflare Turnstile site key is correctly configured.
-
Rate limits โ Form submissions are rate-limited to 10 per IP per hour and 5 per email per hour. If the limit is exceeded, submissions will be rejected.
-
Installation access โ Ensure the target repository has an active Scitor installation with the correct permissions.
Warning
Rate limits are applied per IP address and per email address independently. Both limits must be within bounds for a submission to succeed.