Module crowdin_api.api_resources.webhooks.organization.resource

Classes

class OrganizationWebhooksResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Organization Webhooks.

Webhooks allow you to collect information about events that happen in your Crowdin account. You can select the request type, content type, and add a custom payload, which allows you to create integrations with other systems on your own.

You can configure webhooks for the following events:

• project is created
• project is deleted
• group is created (Crowdin Enterprise only)
• group is deleted (Crowdin Enterprise only)

Use API to create, modify, and delete specific webhooks.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Organization-Webhooks

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Organization-Webhooks

Ancestors

• BaseResource

Class variables

var BASE_URL

Methods

def add_webhook(self, name: str, url: str, events: Iterable[OrganizationWebhookEvent], request_type: WebhookRequestType, is_active: Optional[bool] = None, batching_enabled: Optional[bool] = None, content_type: Optional[WebhookContentType] = None, headers: Optional[Dict[~KT, ~VT]] = None, payload: Optional[Dict[~KT, ~VT]] = None)

Add webhook For Enterprise please use method "add_webhook_enterprise"

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.post

def add_webhook_enterprise(self, name: str, url: str, events: Iterable[EnterpriseOrgWebhookEvent], request_type: WebhookRequestType, is_active: Optional[bool] = None, batching_enabled: Optional[bool] = None, content_type: Optional[WebhookContentType] = None, headers: Optional[Dict[~KT, ~VT]] = None, payload: Optional[Dict[~KT, ~VT]] = None)

Add webhook (enterprise) Events list is different

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.post

def delete_webhook(self, organization_webhook_id: int)

Delete webhook

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.delete

def edit_webhook(self, organization_webhook_id: int, data: Iterable[OrganizationWebhookPatchRequest])

Edit webhook

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.patch

def get_webhook(self, organization_webhook_id: int)

Get webhook

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.get

def get_webhooks_path(self, organization_webhook_id: int)

def list_webhooks(self, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Webhooks

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.getMany