Documentation

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
link

API Documentation

link

API Documentation Enterprise

Return values
OrganizationWebhook|null

        
On this page

Search results