OrganizationWebhookApi
extends AbstractApi
in package
Webhooks allow you to collect information about events that happen in your Crowdin Enterprise organization.
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.
Table of Contents
Methods
- create() : OrganizationWebhook|null
- Add Organization Webhook
- delete() : mixed
- Delete Organization Webhook
- get() : OrganizationWebhook
- Get Organization Webhook
- list() : ModelCollection
- List Organization Webhooks
- update() : OrganizationWebhook|null
- Update Organization Webhook
Methods
create()
Add Organization Webhook
public
create(array<string|int, mixed> $data) : OrganizationWebhook|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[url] required
string[] $data[events] required Enum: "project.created" "project.deleted" Enterprise onyl enum: "project.created" "project.deleted" "group.created" "group.deleted"
string $data[requestType] required Enum: "POST" "GET"
boolean $data[isActive]
boolean $data[batchingEnabled]
string $data[contentType] Default: "application/json" Enum: "multipart/form-data" "application/json" "application/x-www-form-urlencoded"
array $data[headers]
array $data[payload]
Tags
Return values
OrganizationWebhook|nulldelete()
Delete Organization Webhook
public
delete(int $organizationWebhookId) : mixed
Parameters
- $organizationWebhookId : int
Tags
get()
Get Organization Webhook
public
get(int $organizationWebhookId) : OrganizationWebhook
Parameters
- $organizationWebhookId : int
Tags
Return values
OrganizationWebhooklist()
List Organization Webhooks
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
Tags
Return values
ModelCollectionupdate()
Update Organization Webhook
public
update(OrganizationWebhook $organizationWebhook) : OrganizationWebhook|null
Parameters
- $organizationWebhook : OrganizationWebhook