Skip to content

Backgrounds

How-to Guides

Technical References

Tools for Site Management /

Deployment notification webhooks

After code is successfully deployed to a VIP Platform environment, a notification can be sent via webhook, by email, or by sending some JSON (see below) to an arbitrary webhook. Adding webhooks for sites on the VIP Platform can be requested by filing a VIP Support ticket.

Email notifications

To have a successful deployment notification sent by email, file a VIP Support ticket and provide the email address (or addresses) that should receive the notifications.

General purpose webhooks

General purpose webhook pings can fulfill any number of different scenarios, such as:

  • Ping a testing service whenever a particular environment is updated, e.g., to run page speed tests or run through some integration testing to ensure that your checkout process is still working as expected.
  • Log the deployment against a Google spreadsheet.

Whatever service is receiving the ping will need to accept an HTTP POST with a JSON formatted request body which takes the following form:

{
	"domain": "PRIMARY_DOMAIN",
	"branch": "REPOSITORY_BRANCH",
	"sha": "COMMIT_SHA",
	"repo": "GITHUB_ORGANISATION/GITHUB_REPOSITORY"
}

Here’s an example with actual data:

{
	"domain": "https://example.go-vip.net",
	"branch": "develop",
	"sha": "bcb2937404b854e8f265670116d2ba69daee23a0",
	"repo": "wpcomvip/example"
}

Last updated: August 25, 2021