Webhook Events

This guide provides information about the webhook events available in Ownstak and their payload structures.

Available events

Ownstak sends different event types for various activities in your account. Each webhook is configured for a specific event type.

Event Type	Payload Type	Description
`deployment_in_progress`	`deployment`	Triggered when a deployment is in progress.
`deployment_completed`	`deployment`	Triggered when a deployment successfully completes
`deployment_failed`	`deployment`	Triggered when a deployment fails

Payload structures

Each event type has a consistent payload structure. All webhook payloads are sent as JSON and include relevant resources related to the event.

Common payload fields

Common fields

Field	Type	Description
`webhook_event_id`	string	Unique identifier for the webhook event
`webhook_event_type`	string	Type of the webhook event
`webhook_event_created_at`	string	ISO timestamp of when the webhook event was created

Note: Resource ID-s can also be read from HTTP headers. See Request Headers for more details.

Example `deployment` event payload

{
  "webhook_event_id": "d69758z1-x423-45ds-831e-sbcf08aea123",
  "webhook_event_type": "deployment_completed",
  "webhook_event_created_at": "2025-05-27T17:23:49Z",
  "deployment": {
    "id": "d69758z1-x423-45ds-831e-sbcf08aea123",
    "arch": "arm64",
    "links": [
      {
        "url": "https://example-default-2.example-backend.ownstak.ownstak.link",
        "type": "deployment",
        "backend": "AWS production"
      },
      {
        "url": "https://example-default.example-backend.ownstak.ownstak.link",
        "type": "environment",
        "backend": "AWS production"
      }
    ],
    "memory": 1024,
    "status": "completed",
    "runtime": "nodejs20.x",
    "timeout": 20,
    "framework": "nextjs",
    "created_at": "2025-05-27T17:23:49Z",
    "updated_at": "2025-05-27T17:23:51Z",
    "console_url": "http://console.ownstak.com/organizations/ownstak/projects/example/environments/default/deployments/1",
    "environment": {"id": "d69758a6-b413-45d5-831e-0fef08aea025", "name": "default", "slug": "default"},
    "build_number": 2,
    "environment_id": "d69758a6-b413-45d5-831e-0fef08aea025",
    "cloud_backend_deployments": [
      {
        "id": "d358aa6f-0d64-4a67-91ea-b29635f14781",
        "status": "completed",
        "cloud_backend": {
          "id": "1eea4dab-c81a-44d4-a95c-1781aba64951", "name": "AWS production", "slug": "aws-production"
        }
      }
    ]
  }
}

Deployment event payload fields

Field	Type	Description
`id`	string	Unique identifier for the deployment
`arch`	string	Architecture of the deployment (e.g., "arm64", "x86_64")
`links`	array	Array of URL links related to this deployment
`memory`	number	Memory allocation in MB
`status`	string	Current status of the deployment
`runtime`	string	Runtime environment (e.g., "nodejs20.x")
`timeout`	number	Function timeout in seconds
`framework`	string	Framework used (e.g., "nextjs", "express")
`created_at`	string	ISO timestamp of when the deployment was created
`updated_at`	string	ISO timestamp of when the deployment was last updated
`console_url`	string	URL to view the deployment in the Ownstak Console
`environment`	object	Information about the environment this deployment belongs to
`build_number`	number	Sequential build number within the environment
`environment_id`	string	Unique identifier for the environment
`cloud_backend_deployments`	array	Details about the deployment across different cloud backends

Available events​

Payload structures​

Common payload fields​

Common fields​

Example deployment event payload​

Deployment event payload fields​