Project Webhooks

Send a JSON callback after a successful service deployment and inspect the recorded result.

Project webhooks notify an external HTTP endpoint after a service deployment completes successfully.

Configure the Endpoint

  1. Open Project settings > Webhooks.
  2. Enable webhooks.
  3. Enter the base URL.
  4. Save the settings.

StationOps appends servicedeploy/completed to the configured base URL. End the base URL with / so the resulting address is valid, for example:

https://automation.example.com/stationops/

The resulting callback URL is:

https://automation.example.com/stationops/servicedeploy/completed

Use HTTPS and an endpoint dedicated to StationOps events. Do not put credentials or secrets in the URL.

Event and Payload

The current event is Service Deploy Completed. StationOps sends an HTTP POST with Content-Type: application/json after a successful service deployment.

{
  "projectId": "project-id",
  "serviceReleaseId": "release-id",
  "environmentConfigId": "production",
  "componentConfigId": "api"
}

Identifiers are stable references for correlation; fetch or store human-readable names separately if the receiving system needs them.

Receiver Requirements

  • Return a successful HTTP response promptly.
  • Make processing idempotent because event delivery may be retried by surrounding systems.
  • Queue long-running work instead of blocking the request.
  • Validate the identifiers against the expected project and environment.
  • Log the received time and relevant IDs without logging secrets.

Inspect a Result

Open the completed service deployment and select its webhook result when available. Review the request URL and body together with the recorded response code and body.

If no result appears, confirm the deployment completed successfully, the project webhook is enabled, and the base URL was saved before that deployment. If the request failed, test the final appended URL, TLS certificate, DNS, firewall, and receiver response outside StationOps.