Use cases · CI and deploys

Know when a deploy lands, or doesn't.

Vercel and GitHub can call Hook directly. For anything else, one step at the end of a pipeline sends a notification with the result, a link to the run and the right priority.

  • Vercel and GitHub are recognised by name
  • Hook-Click opens the run when you tap the browser notification
  • Keep the workspace key in a CI secret: anyone with it can post to you
A Vercel deployment notification in Hook's inbox

Set it up in a minute. Three steps.

  1. Step 1

    Use the platform's webhooks

    Point Vercel deployment webhooks or GitHub workflow_run events at a /deploys topic.

  2. Step 2

    Or add a step

    Call your endpoint from the pipeline with the outcome as the title and a link to the run.

  3. Step 3

    Notify only on failure

    Set the topic to notify from high priority, and send successes at default.

.github/workflows/deploy.yml
- name: Notify Hook
  if: always()
  run: |
    curl -s "https://gethook.app/workspace/${{ secrets.HOOK_KEY }}/deploys" \
      -H "Hook-Title: Deploy ${{ job.status }}" \
      -H "Hook-Priority: ${{ job.status == 'success' && 'default' || 'urgent' }}" \
      -H "Hook-Click: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
      -d "${{ github.repository }}@${{ github.sha }}"

Replace {workspace_key} with the key shown in the app. Fields like title and priority are explained in Publishing messages.

What people ask before they set it up.

Can I see the notification on my laptop too?

Yes. Sign in at gethook.app/app with the same account; Pro adds browser notifications next to the iPhone.

Compared with other tools for this job.

More uses for Hook.

Get the next request on your phone. Free to start.