Actions65
- String/Asset Comments Actions
- Glossaries Actions
- Style Guides Actions
- Placeholders Actions
- AI Actions
- Languages Actions
- Webhooks Actions
- Organization Webhooks Actions
- Applications Actions
- Upload Application Bundle
- List Application Installations
- Install Application
- Get Application Installation
- Delete Application Installation
- Edit Application Installation
- Get Application Installation Update
- Apply Application Installation Update
- Get Application Data
- Update or Restore Application Data
- Add Application Data
- Delete Application Data
- Edit Application Data
- Integrations Actions
- Advisor Actions
- External QA Checks Actions
- Security Logs Actions
Webhooks → Add Webhook
AI-generatedSummary
Add a webhook to a specified Crowdin Enterprise project to receive notifications for selected project events via HTTP requests.
Inputs
- Authentication — Choose OAuth2 or Access Token method for authentication (OAuth2 is recommended).
- Project Id (required) — Select the target project by its identifier to which the webhook will be added.
- Name (required) — Specify a name for the webhook.
- Url (required) — Provide the webhook endpoint URL to which event notifications will be sent.
- Events (required) — Select one or more events that will trigger the webhook notifications, such as file changes, project status updates, translation activities, commenting, suggestions, and task events.
- Request Type (required) — Choose the HTTP method (POST or GET) used to send webhook requests.
- Is Active — Define whether the webhook is active upon creation.
- Batching Enabled — Specify whether webhook event batching is enabled to group multiple events.
- Content Type — Set the Content-Type header for webhook payloads if applicable (e.g., application/json).
- Headers — Optionally add custom HTTP headers sent with the webhook request, such as authorization headers.
- Payload — Define a custom payload structure for the webhook.
- Request Options — Configure advanced request options like batching size and interval, SSL validation behavior, proxy settings, and request timeout.
Output shape
a JSON object representing the created webhook with its configuration details.
The operation returns the newly created webhook details from the Crowdin API. All required fields must be provided. The user must supply a valid project ID and webhook URL. Payload and headers are optional and can customize the webhook behavior. Request options affect the underlying HTTP request and batching behavior.
Examples
Example 1: Create a webhook named 'Proofread' for project 'MyProject' to send POST requests to https://webhook\.site/example when files are added or updated, with default active state and JSON content type.
Project Id='MyProject', Name='Proofread', Url='https://webhook.site/example', Events=['file.added','file.updated'], Request Type=POST, Content Type='application/json', Is Active=true