---
title: "Add Webhook"
method: POST
path: "/webhooks"
tags: ["Organization Webhooks"]
---

# Add Webhook

`POST /webhooks`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/webhooks`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/webhooks/post.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `webhook` (Read and Write).

## Request body

- CrowdinOrganizationWebhookCreateForm
  - `name` string, required: Webhook name
  - `url` string, required: Webhook URL
  - `events` Events[], required: Webhook events
  - `requestType` 'POST' | 'GET', required: Webhook request type
  - `isActive` boolean: Defines whether webhook is active
  - `batchingEnabled` boolean: Defines whether webhook batching is enabled
  - `contentType` 'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded': Webhook content type
  - `headers` object: Webhook headers
  - `payload` object: Custom webhook payload
    - `project.created` object: Read more about [Events payload examples](https://developer.crowdin.com/webhooks). Additionally, you can check out Events payloads while creating webhooks via UI in your Crowdin profile settings > Webhooks tab > click Add webhook.

## Response `201`

Webhook was successfully added

- CrowdinOrganizationWebhookResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` CrowdinOrganizationWebhook, required
    - `id` integer
    - `name` string
    - `url` string, nullable
    - `events` string[]
    - `headers` string[]
    - `payload` object: Read more about [Events payload examples](https://developer.crowdin.com/webhooks). Additionally, you can check out Events payloads while creating webhooks via UI in your Crowdin project > Tools tab > Webhooks section > click Add webhook.
    - `isActive` boolean
    - `batchingEnabled` boolean
    - `requestType` string
    - `contentType` string, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `405`: Method Not Allowed

---

[API](https://skmtc.dev/crowdin/apis/crowdin-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-api-v2/revisions/27aae7751699?raw)