In order to pull and display release information on the Events page, you must configure a post-release hook in your deployment pipeline to notify Noibu when you are shipping code. Presently, Noibu only has an integration with GitLab, but you can create a generic webhook for any tool, provided it can send an HTTP request and retrieve release data. This article contains the basic requirements to establish a generic webhook. For tool specific guides, see our resources on creating webhooks with GitLab and Jenkins.
Before beginning this process, retrieve your Domain's Unique ID String.
To create a webhook, add a post-deploy step in your script to notify Noibu via the following HTTP request:
HTTP `POST` To https://webhook.noibu.com/release_webhook/<domain-id>
<domain-id> placeholder with your domain’s unique identifier. For help pulling your
domain-id, contact our Solutions Engineering team.
The request body must include the following fields:
|component||String||What piece of your site did you release? (open field: "frontend", "backend", "checkout", "marketing", etc...)|
|title||String||Summary of the release. This will likely be configured as a variable.|
|description||String||Details about the release. Value can be “null”. This will likely be configured as a variable.|
|status||String||Did the release successfully deploy or was there an error? ("success" or "failed") This will likely be configured as a variable.|
|version||String||What version number/hash ID of the software was released? (open field: "1.0.0", commit hash, or ticket ID) This will likely be configured as a variable.|
|release_time||String||The time the release went live. Use the RFC3339 timestamp. This will likely be configured as a variable.|
The request body should look something like this:
"title":"Fake Release #2",
Learn more about the Events page.