Class OrganizationWebhooks

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.

Hierarchy (view full)

CrowdinApi
- OrganizationWebhooks

Index

Constructors

Methods

addWebhook deleteWebhook editWebhook getWebhook graphql listWebhooks withFetchAll

Constructors

constructor

new OrganizationWebhooks(credentials, config?): OrganizationWebhooks
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns OrganizationWebhooks
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:224

Methods

addWebhook

addWebhook(request): Promise<ResponseObject<OrganizationWebhook>>
Parameters
- request: AddOrganizationWebhookRequest
  request body
Returns Promise<ResponseObject<OrganizationWebhook>>
See
https://developer.crowdin.com/api/v2/#operation/api.webhooks.post
- Defined in organizationWebhooks/index.ts:23

deleteWebhook

deleteWebhook(webhookId): Promise<void>
Parameters
- webhookId: number
  webhook identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.webhooks.delete
- Defined in organizationWebhooks/index.ts:43

editWebhook

editWebhook(webhookId, request): Promise<ResponseObject<OrganizationWebhook>>
Parameters
- webhookId: number
  webhook identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<OrganizationWebhook>>
See
https://developer.crowdin.com/api/v2/#operation/api.webhooks.patch
- Defined in organizationWebhooks/index.ts:53

getWebhook

getWebhook(webhookId): Promise<ResponseObject<OrganizationWebhook>>
Parameters
- webhookId: number
  webhook identifier
Returns Promise<ResponseObject<OrganizationWebhook>>
See
https://developer.crowdin.com/api/v2/#operation/api.webhooks.get
- Defined in organizationWebhooks/index.ts:34

graphql

graphql<T>(req): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:258

listWebhooks

listWebhooks(options?): Promise<ResponseList<OrganizationWebhook>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<OrganizationWebhook>>
See
https://developer.crowdin.com/api/v2/#operation/api.webhooks.getMany
- Defined in organizationWebhooks/index.ts:14

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:313