Pipelines That Run on Their Own
2 min read
The inbound webhook lets your CI tell Hawzu that a build Hawzu started has finished, so the results are imported a little sooner. Hawzu already checks those builds regularly until they finish, so you don’t need the webhook for results to arrive.
This is not the same feature as Webhooks. Those are Hawzu calling your systems when things change in a workspace. The signature scheme is the same for both.
Get the webhook URL and secret
Section titled “Get the webhook URL and secret”Each automated test run’s pipeline has its own webhook URL and secret. No screen in Hawzu shows them yet, so contact support to get them for your pipeline.
What to send
Section titled “What to send”When a build finishes, your CI posts its standard build notification as JSON, for example:
- Jenkins: the Notification plugin’s payload.
- GitHub Actions: a
workflow_runevent. - GitLab CI: a Pipeline Event.
Hawzu reads the build number and its result from it. Notifications for a build that is still running are accepted, and the build keeps being checked until it finishes.
Request bodies can be up to 1 MB.
Sign the request
Section titled “Sign the request”Sign each request with an HMAC-SHA256 of the raw request body, using the pipeline’s webhook secret as the key. Send it in the X-Hawzu-Signature header as the hex digest prefixed with the algorithm:
A missing or wrong signature gets a 401 response.
When to use which
Section titled “When to use which”| Situation | Use |
|---|---|
| QA decides when the suite runs | Run from the test run. See Create an Automated Test Run. |
| Hawzu started the build and you want results to arrive sooner | This webhook |
| The pipeline runs on its own schedule, or Hawzu didn’t start the build | Importing CI Results: post the report itself |
| Your CI isn’t Jenkins, GitHub Actions or GitLab CI | Importing CI Results |