Module crowdin_api.api_resources.webhooks.organization.resource

Classes

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

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://developer.crowdin.com/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://developer.crowdin.com/enterprise/api/v2/#operation/api.webhooks.post

def delete_webhook(self, organization_webhook_id: int)

Delete webhook

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

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

Edit webhook

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

def get_webhook(self, organization_webhook_id: int)

Get webhook

Link to documentation: https://developer.crowdin.com/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://developer.crowdin.com/api/v2/#operation/api.webhooks.getMany