Skip to content

fix(dashboard): correct webhook example payload to match v2 schema #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beran-t merged 1 commit into from
May 14, 2026
Merged

fix(dashboard): correct webhook example payload to match v2 schema #324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/features/dashboard/settings/webhooks/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@ export const WEBHOOK_EVENTS = [
export type WebhookEvent = (typeof WEBHOOK_EVENTS)[number]

export const WEBHOOK_EXAMPLE_PAYLOAD = `{
"version": "v1",
"id": "<UUID>",
"version": "v2",
"type": "sandbox.lifecycle.created",
"eventData": null,
"sandboxBuildId": "<UUID>",
"sandboxExecutionId": "<UUID>",
"sandboxId": "<SANDBOX_ID>",
"sandboxTeamId": "<UUID>",
"sandboxTemplateId": "<TEMPLATE_ID>",
"timestamp": "<ISO_8601_TIMESTAMP>"
"timestamp": "<ISO_8601_TIMESTAMP>",
"event_category": "lifecycle",
"event_label": "create",
"sandbox_id": "<SANDBOX_ID>",
Comment on lines +17 to +18

@chatgpt-codex-connector chatgpt-codex-connector Bot May 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve event_data in the v2 example

For v2 deliveries that include sandbox metadata or execution details, the webhook schema exposes that data under snake_case event_data; this update removes the old eventData field but never adds its v2 replacement. Users copying this example for payload validation or handler typings will reject or ignore real deliveries that contain event data, especially paused/killed events and sandboxes with metadata.

Useful? React with 👍 / 👎.

"sandbox_execution_id": "<UUID>",
"sandbox_template_id": "<TEMPLATE_ID>",
"sandbox_build_id": "<UUID>",
"sandbox_team_id": "<UUID>"
}

// Payload structure may vary by event type.
// Payload structure may vary by event type.
// See docs for full schema.`

export const WEBHOOK_SIGNATURE_VALIDATION_DOCS_URL =
Expand Down
Loading