com.crowdin.client.webhooks

Class WebhooksApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.webhooks.WebhooksApi

public class WebhooksApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
WebhooksApi(Credentials credentials)
WebhooksApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<Webhook>	addWebhook(java.lang.Long projectId, AddWebhookRequest request)
void	deleteWebhook(java.lang.Long projectId, java.lang.Long webhookId)
ResponseObject<Webhook>	editWebhook(java.lang.Long projectId, java.lang.Long webhookId, java.util.List<PatchRequest> request)
ResponseObject<Webhook>	getWebhook(java.lang.Long projectId, java.lang.Long webhookId)
ResponseList<Webhook>	listWebhooks(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksApi

public WebhooksApi(Credentials credentials)

WebhooksApi

public WebhooksApi(Credentials credentials,
                   ClientConfig clientConfig)

Method Detail

listWebhooks

public ResponseList<Webhook> listWebhooks(java.lang.Long projectId,
                                          java.lang.Integer limit,
                                          java.lang.Integer offset)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

projectId - project identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of webhooks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addWebhook

public ResponseObject<Webhook> addWebhook(java.lang.Long projectId,
                                          AddWebhookRequest request)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getWebhook

public ResponseObject<Webhook> getWebhook(java.lang.Long projectId,
                                          java.lang.Long webhookId)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

projectId - project identifier

webhookId - webhook identifier

Returns:

webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteWebhook

public void deleteWebhook(java.lang.Long projectId,
                          java.lang.Long webhookId)
                   throws HttpException,
                          HttpBadRequestException

Parameters:

projectId - project identifier

webhookId - webhook identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editWebhook

public ResponseObject<Webhook> editWebhook(java.lang.Long projectId,
                                           java.lang.Long webhookId,
                                           java.util.List<PatchRequest> request)
                                    throws HttpException,
                                           HttpBadRequestException

Parameters:

projectId - project identifier

webhookId - webhook identifier

request - request object

Returns:

updated webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation