Skip to main content

Before you begin

Install the CLI, authenticate with rig login, and use an isolated test workspace. These examples require the v0.13 CLI. The manifests have been checked with the v0.13 parser; verify application health after deployment. Open the webhook-receiver source. These manifests explicitly select incremental deployment.

Deploy from your machine

From a terminal on your machine, clone the repository and enter the example directory:
Supply WEBHOOK_HMAC_KEY through your shell or an ignored environment file. The committed demo value is for testing only. A missing required secret is a deployment configuration error. Before deployment, run locally:
The generated credential uses a named map:
The process receives CRED_ENDPOINT_TOKEN; do not commit the generated value.
Record the workspace and app IDs printed by deployment. Use those exact IDs wherever this guide shows WORKSPACE_ID or APP_ID; do not guess a public URL from an app name.

Verify the result

Use the dashboard’s Send test webhook control. Confirm a valid signature result; send a wrong signature to verify rejection. Recent events are held in memory and disappear when the process restarts.

Access and recovery

The route defaults to private. The dashboard displays an endpoint token; do not expose the inspector publicly without reviewing its access model. If deployment fails, read the terminal error and installation output before retrying. rig app logs --app APP_ID --install shows install logs when an app exists. Check required credentials, resource limits, the start command, and the configured health path. An image deployment may require explicit root-filesystem replacement consent; do not add --reimage to a workspace containing data you need.

Clean up

After saving any data you need, delete only the isolated example workspace. This deletes its applications and workspace data; inspect persistent volumes and snapshots separately before removing them.
Continue with deployment guides or the manifest reference.