PreviewHQ
  • Introduction
  • Basics
    • What is Continuous Product Review?
    • What is a Preview Environment?
    • Use Cases
      • Product and Stakeholder Review
      • QA Environments
      • Automated End-to-End Testing
      • Sales Demo Environments
      • Support Training
  • Getting Started
    • Installation
    • Add Configuration
    • Add a Cluster
    • Create a Deployment
      • with a Pull Request
      • with the Dashboard
      • with the CLI
      • with the API
  • Technical Stuff
    • Defining Deployments
      • Helm Charts
      • Kubernetes Manifests
      • [UNRELEASED] Terraform
    • Configuration File
      • Branches
      • Services
      • Chart Repositories
      • Chart Values
      • Docker Registries
      • Images
      • Webhooks
    • Template Strings
    • Using Seed Data
      • Using Shared Data Sources
    • Access Control
      • Preview Application Access
      • Preview Environment Access
    • Using Third-Party Integrations
    • Debugging
    • Current Limitations
  • Sample Applications
    • Emojivoto
    • Guestbook - Helm
    • Guestbook - Manifests
  • misc
    • FAQ
    • Changelog
    • Telemetry Data
    • Links
      • Homepace
      • Dashboard
Powered by GitBook
On this page

Was this helpful?

  1. Technical Stuff
  2. Configuration File

Webhooks

Webhooks can be posted at the end of each workflow. Webhook endpoints can be specified with the webhooks config key.

webhooks:
  - url: https://domain.com/webhook
  - url: https://other-domain.com/webhook

At this point Webhooks are a very basic feature. Retries are not currently supported, and reliability and deliverability can not be guaranteed. If you are depending on this feature please let us know and resources can be dedicated to its further development.

The body of the webhook is a JSON blob of the following structure:

{
	"id": Integer ,
	"installation_id": Integer ,
	"repository_id": Integer ,
	"repository": {
		"id": Integer ,
		"organization_id": Integer ,
		"service": String ,
		"project": String ,
		"name": String ,
		"full_name": String ,
		"git_url": String ,
		"private": String ,
		"enabled": String ,
		"created_at": Timestamp (ISO),
		"updated_at": Timestamp (ISO),
	},
	"branch": String ,
	"namespace": String ,
	"name": String ,
	"subdomain": String ,
	"full_environment_url": String ,
	"origin": String ,
	"pull_request_id": Integer ,
	"auto_update": Integer ,
	"state": String ,
	"created_at": Timestamp (ISO),
	"updated_at": Timestamp (ISO),
}

PreviousImagesNextTemplate Strings

Last updated 4 years ago

Was this helpful?