> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Get notified about deployment events via webhooks

## Overview

Qovery enables organization-level webhooks to notify external applications when environment events occur. This feature facilitates integration with third-party tools and communication platforms like Slack.

<img src="https://mintcdn.com/qovery/0DUQ_vx2Z8m51gn0/images/integration/webhook/webhook_access.png?fit=max&auto=format&n=0DUQ_vx2Z8m51gn0&q=85&s=9dccd3eb9aaaf49ec32d0ea490184f80" alt="Webhook Access" width="2784" height="1820" data-path="images/integration/webhook/webhook_access.png" />

## Primary Use Cases

* Inform external systems about deployment status changes
* Share deployment notifications in Slack channels

## Supported Events

Webhooks trigger on the following deployment events:

* Deployment initiation
* Successful deployment completion
* Deployment cancellation
* Deployment failure

## Webhook Types

**Standard**: Transmits payload in Qovery's proprietary format to a specified URL.

**Slack**: Delivers pre-formatted messages using Slack's messaging protocol.

## Creation Process

Access Organization settings → Webhook section → Select "Add New"

### Required Parameters

| Parameter                  | Purpose                                                                                    |
| -------------------------- | ------------------------------------------------------------------------------------------ |
| `URL`                      | External application's webhook endpoint                                                    |
| `kind`                     | Webhook classification: `STANDARD` or `SLACK`                                              |
| `events`                   | Deployment events triggering the webhook                                                   |
| `secret`                   | (Optional) Authentication credential for webhook calls; used in the header `Qovery-Secret` |
| `description`              | (Optional) Functional explanation                                                          |
| `environment_types_filter` | (Optional) Filter by `PRODUCTION`, `DEVELOPMENT`, `STAGING`, `PREVIEW`                     |
| `project_names_filter`     | (Optional) Filter by project names; case-insensitive; supports wildcards                   |

## Management Operations

**Edit**: Click the wheel icon and toggle "Enable" to temporarily disable.

**Delete**: Click the bin icon; confirmation modal appears.

## Standard Webhook Payload Structure

The POST request includes:

```json theme={null}
{
  "created_at": "ISO-8601-timestamp",
  "event_type": "DEPLOYMENT_STARTED|DEPLOYMENT_CANCELLED|DEPLOYMENT_SUCCESSFUL|DEPLOYMENT_FAILURE",
  "payload_type": "DEPLOYMENT",
  "payload_id": "unique-identifier",
  "payload": {
    "id": "deployment-id",
    "current_status": "state-enum",
    "desired_status": "state-enum",
    "organization": {},
    "project": {},
    "environment": {},
    "applications": [],
    "databases": [],
    "containers": [],
    "jobs": [],
    "logs": []
  }
}
```

## Key Features

* Combine filters: `environment_types_filter` and `project_names_filter` work together
* Wildcard support in project name filtering
* Selective event triggering based on deployment lifecycle stage