---
title: "Deployment succeeded"
method: POST
path: "deployment.succeeded"
tags: ["Deployments"]
---

# Deployment succeeded

`POST deployment.succeeded` (webhook)

Triggered when a site deploy builds, ships and passes its smoke check

## Headers

- `webhook-id` string, required
- `webhook-timestamp` string, required
- `webhook-signature` string, required

## Payload

- object
  - `id` string, required: Unique identifier for this webhook event
  - `object` 'event', required
  - `type` 'deployment.succeeded', required: The event type
  - `created_at` string, date-time, required: ISO 8601 timestamp of when the event was created
  - `api_version` string, required: API version used to generate the payload
  - `data` object, required: `object` is the resource exactly as its API endpoint returns it.
    - `object` Deployment, required
      - `id` string, required
      - `object` string, required
      - `site` string, required
      - `status` 'pending' | 'building' | 'live' | 'failed' | 'superseded' | 'unpublished', required
      - `commit_sha` string, nullable, required
      - `is_live` boolean, required
      - `url` string, nullable, required
      - `triggered_by` string, nullable, required
      - `error_message` string, nullable, required
      - `db_bookmark` string, nullable, required
      - `current_stage` string, nullable, required
      - `stages` unknown[], required
        - unknown
      - `duration_seconds` number, nullable, required
      - `elapsed_seconds` number, nullable, required
      - `started_at` string, nullable, required
      - `finished_at` string, nullable, required
      - `created_at` string, required

## Acknowledgement `200`

Return any 2xx status within 5 seconds to acknowledge receipt.

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)