Guide

Laravel Nightwatch issues, straight onto your board

Exceptions and slow requests become stories your team can plan. When the story is done, the issue is resolved in Nightwatch.

Set it up

  1. 1

    Set it up in team settings

    As a team admin, open Settings → Team in Scrumpy, find the Nightwatch card and click “Set up Nightwatch”. You get a webhook URL that belongs to this team only.

  2. 2

    Add the webhook in Nightwatch

    In Nightwatch, open your application, go to Issues settings → Webhooks and add a webhook. Paste the URL and select the issue opened, reopened, resolved and ignored events.

  3. 3

    Paste the signing secret back

    Nightwatch shows a signing secret for the webhook. Paste it into the Nightwatch card and save. Scrumpy checks every request against it and refuses anything that does not match.

  4. 4

    Choose what becomes a story

    Pick the issue types to sync (exceptions, slow routes, slow jobs, slow commands, slow scheduled tasks), which environments count, and whether handled exceptions are skipped. Then choose the story type, the priority per kind of issue and where new stories go: the backlog, the current sprint or the next one.

  5. 5

    Connect Nightwatch to resolve issues

    Click “Connect Nightwatch” and approve the connection in your browser. From then on, when a story reaches your team's final done status, Scrumpy resolves its issue in Nightwatch.

What happens when

Issue opened
A new story with the exception class, message and file and line, or the slow route, job or command with its duration, plus a link to the issue.
Issue reopened
A comment on the story while it is still open. Once the story is done or archived, a new story is created and linked to the old one.
Issue resolved or ignored
A comment on the story. The story keeps its status: your team decides when work is done.
Story done
The issue is resolved in Nightwatch. If that fails, the story still moves and team settings show why.

Good to know

Can one Nightwatch application feed several teams?
No. A Nightwatch application has one webhook, so it sends its issues to one Scrumpy team. Each team gets its own webhook URL.
Who can set it up?
Only admins of the organization. Other members see the stories and comments it creates.
Does a burst of errors create a pile of stories?
No. Nightwatch groups occurrences into one issue, and Scrumpy keeps one story per issue. Repeated deliveries of the same event are ignored.
Do I need to connect Nightwatch?
Only to resolve issues automatically. Without it, stories and comments still arrive; you resolve issues in Nightwatch yourself.

Building for developers? See how Scrumpy fits a developer team.