Class Webhooks

Webhooks allow you to collect information about events that happen in your Crowdin projects.

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
- Webhooks

Index

Constructors

constructor

Methods

addWebhook deleteWebhook editWebhook getWebhook getWebhookDelivery graphql listAllWebhookDeliveries listWebhookDeliveries listWebhooks resendWebhookDelivery testWebhook withFetchAll

Constructors

constructor

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

Methods

addWebhook

addWebhook(projectId, request): Promise<ResponseObject<Webhook>>
Parameters
- projectId: number
  project identifier
- request: AddWebhookRequest
  request body
Returns Promise<ResponseObject<Webhook>>
Required Scope
project.webhook:write

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.post
- Defined in webhooks/index.ts:43

deleteWebhook

deleteWebhook(projectId, webhookId): Promise<void>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
Returns Promise<void>
Required Scope
project.webhook:write

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.delete
- Defined in webhooks/index.ts:68

editWebhook

editWebhook(projectId, webhookId, request): Promise<ResponseObject<Webhook>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Webhook>>
Required Scope
project.webhook:write

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.patch
- Defined in webhooks/index.ts:80

getWebhook

getWebhook(projectId, webhookId): Promise<ResponseObject<Webhook>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
Returns Promise<ResponseObject<Webhook>>
Required Scope
project.webhook:read

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.get
- Defined in webhooks/index.ts:57

getWebhookDelivery

getWebhookDelivery(projectId, webhookId, deliveryId): Promise<ResponseObject<WebhookDeliveryDetails>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
- deliveryId: number
  delivery identifier
Returns Promise<ResponseObject<WebhookDeliveryDetails>>
Required Scope
project.webhook:read

See
https://support.crowdin.com/developer/api/v2/#tag/Webhooks/operation/api.projects.webhooks.deliveries.get
- Defined in webhooks/index.ts:135

graphql

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

listAllWebhookDeliveries

listAllWebhookDeliveries(projectId, options?): Promise<ResponseList<WebhookDelivery>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListAllWebhookDeliveriesOptions
  optional parameters for the request
Returns Promise<ResponseList<WebhookDelivery>>
Required Scope
project.webhook:read

See
https://support.crowdin.com/developer/api/v2/#tag/Webhooks/operation/api.projects.webhooks.deliveries.getAll
- Defined in webhooks/index.ts:95

listWebhookDeliveries

listWebhookDeliveries(projectId, webhookId, options?): Promise<ResponseList<WebhookDelivery>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
- Optionaloptions: ListWebhookDeliveriesOptions
  optional parameters for the request
Returns Promise<ResponseList<WebhookDelivery>>
Required Scope
project.webhook:read

See
https://support.crowdin.com/developer/api/v2/#tag/Webhooks/operation/api.projects.webhooks.deliveries.getMany
- Defined in webhooks/index.ts:115

listWebhooks

listWebhooks(projectId, options?): Promise<ResponseList<Webhook>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<Webhook>>
Required Scope
project.webhook:read

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany
- Defined in webhooks/index.ts:15
listWebhooks(projectId, limit?, offset?): Promise<ResponseList<Webhook>>
Parameters
- projectId: number
  project identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Webhook>>
Required Scope
project.webhook:read

Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany
- Defined in webhooks/index.ts:24

resendWebhookDelivery

resendWebhookDelivery(projectId, webhookId, deliveryId): Promise<ResponseObject<WebhookDelivery>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
- deliveryId: number
  delivery identifier
Returns Promise<ResponseObject<WebhookDelivery>>
Required Scope
project.webhook:write

See
https://support.crowdin.com/developer/api/v2/#tag/Webhooks/operation/api.projects.webhooks.deliveries.resend.post
- Defined in webhooks/index.ts:151

testWebhook

testWebhook(projectId, webhookId, request?): Promise<ResponseObject<WebhookTestResult>>
Parameters
- projectId: number
  project identifier
- webhookId: number
  webhook identifier
- request: TestWebhookRequest = {}
  request body
Returns Promise<ResponseObject<WebhookTestResult>>
Required Scope
project.webhook:write

See
https://support.crowdin.com/developer/api/v2/#tag/Webhooks/operation/api.projects.webhooks.tests.post
- Defined in webhooks/index.ts:167

withFetchAll

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

Class Webhooks

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Webhooks

Methods

addWebhook

Parameters

Returns Promise<ResponseObject<Webhook>>

Required Scope

See

deleteWebhook

Parameters

Returns Promise<void>

Required Scope

See

editWebhook

Parameters

Returns Promise<ResponseObject<Webhook>>

Required Scope

See

getWebhook

Parameters

Returns Promise<ResponseObject<Webhook>>

Required Scope

See

getWebhookDelivery

Parameters

Returns Promise<ResponseObject<WebhookDeliveryDetails>>

Required Scope

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listAllWebhookDeliveries

Parameters

Returns Promise<ResponseList<WebhookDelivery>>

Required Scope

See

listWebhookDeliveries

Parameters

Returns Promise<ResponseList<WebhookDelivery>>

Required Scope

See

listWebhooks

Parameters

Returns Promise<ResponseList<Webhook>>

Required Scope

See

Parameters

Returns Promise<ResponseList<Webhook>>

Required Scope

Deprecated

See

resendWebhookDelivery

Parameters

Returns Promise<ResponseObject<WebhookDelivery>>

Required Scope

See

testWebhook

Parameters

Returns Promise<ResponseObject<WebhookTestResult>>

Required Scope

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string