All URIs are relative to https://api-v2.fattureincloud.it
| Method | HTTP request | Description |
|---|---|---|
| createWebhooksSubscription | POST /c/{company_id}/subscriptions | Create a Webhook Subscription |
| deleteWebhooksSubscription | DELETE /c/{company_id}/subscriptions/{subscription_id} | Delete Webhooks Subscription |
| getWebhooksSubscription | GET /c/{company_id}/subscriptions/{subscription_id} | Get Webhooks Subscription |
| listWebhooksSubscriptions | GET /c/{company_id}/subscriptions | List Webhooks Subscriptions |
| modifyWebhooksSubscription | PUT /c/{company_id}/subscriptions/{subscription_id} | Modify Webhooks Subscription |
| verifyWebhooksSubscription | POST /c/{company_id}/subscriptions/{subscription_id}/verify | Verify Webhooks Subscription |
CreateWebhooksSubscriptionResponse createWebhooksSubscription(companyId, opts)
Create a Webhook Subscription
Register some webhooks Subscriptions.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
let opts = {
'createWebhooksSubscriptionRequest': {"data":{"sink":"http://www.test.com","types":["it.fattureincloud.webhooks.entities.create","it.fattureincloud.webhooks.issued_documents.create"],"verification_method":"header"}} // CreateWebhooksSubscriptionRequest |
};
apiInstance.createWebhooksSubscription(companyId, opts).then((result) => {
console.log('API called successfully. Returned result: ' + JSON.stringify(result));
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. | |
| createWebhooksSubscriptionRequest | CreateWebhooksSubscriptionRequest | [optional] |
CreateWebhooksSubscriptionResponse
- Content-Type: application/json
- Accept: application/json
deleteWebhooksSubscription(companyId, subscriptionId)
Delete Webhooks Subscription
Delete a webhooks subscription.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
apiInstance.deleteWebhooksSubscription(companyId, subscriptionId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. | |
| subscriptionId | String | The ID of the subscription. |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
GetWebhooksSubscriptionResponse getWebhooksSubscription(companyId, subscriptionId)
Get Webhooks Subscription
Get a webhooks subscription.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
apiInstance.getWebhooksSubscription(companyId, subscriptionId).then((result) => {
console.log('API called successfully. Returned result: ' + JSON.stringify(result));
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. | |
| subscriptionId | String | The ID of the subscription. |
GetWebhooksSubscriptionResponse
- Content-Type: Not defined
- Accept: application/json
ListWebhooksSubscriptionsResponse listWebhooksSubscriptions(companyId)
List Webhooks Subscriptions
List active webhooks subscriptions.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
apiInstance.listWebhooksSubscriptions(companyId).then((result) => {
console.log('API called successfully. Returned result: ' + JSON.stringify(result));
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. |
ListWebhooksSubscriptionsResponse
- Content-Type: Not defined
- Accept: application/json
ModifyWebhooksSubscriptionResponse modifyWebhooksSubscription(companyId, subscriptionId, opts)
Modify Webhooks Subscription
Edit a webhooks subscription.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
let opts = {
'modifyWebhooksSubscriptionRequest': new fattureInCloudSdk.ModifyWebhooksSubscriptionRequest() // ModifyWebhooksSubscriptionRequest |
};
apiInstance.modifyWebhooksSubscription(companyId, subscriptionId, opts).then((result) => {
console.log('API called successfully. Returned result: ' + JSON.stringify(result));
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. | |
| subscriptionId | String | The ID of the subscription. | |
| modifyWebhooksSubscriptionRequest | ModifyWebhooksSubscriptionRequest | [optional] |
ModifyWebhooksSubscriptionResponse
- Content-Type: application/json
- Accept: application/json
verifyWebhooksSubscription(companyId, subscriptionId, opts)
Verify Webhooks Subscription
Verify a webhook subscription.
import fattureInCloudSdk from '@fattureincloud/fattureincloud-js-sdk';
let defaultClient = fattureInCloudSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
let OAuth2AuthenticationCodeFlow = defaultClient.authentications['OAuth2AuthenticationCodeFlow'];
OAuth2AuthenticationCodeFlow.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new fattureInCloudSdk.WebhooksApi();
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
let opts = {
'verifyWebhooksSubscriptionRequest': new fattureInCloudSdk.VerifyWebhooksSubscriptionRequest() // VerifyWebhooksSubscriptionRequest |
};
apiInstance.verifyWebhooksSubscription(companyId, subscriptionId, opts).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| companyId | Number | The ID of the company. | |
| subscriptionId | String | The ID of the subscription. | |
| verifyWebhooksSubscriptionRequest | VerifyWebhooksSubscriptionRequest | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: application/json