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 |
CreateWebhooksSubscriptionResponse createWebhooksSubscription(companyId, opts)
Create a Webhook Subscription
Register some webhooks Subscriptions.
import { Configuration, WebhooksApi , CreateWebhooksSubscriptionRequest } from '@fattureincloud/fattureincloud-ts-sdk';
// Configure OAuth2 access token for authorization:
const apiConfig = new Configuration({
accessToken: "YOUR ACCESS TOKEN"
});
let apiInstance = new WebhooksApi(apiConfig);
let companyId = 12345; // Number | The ID of the company.
let createWebhooksSubscriptionRequest: CreateWebhooksSubscriptionRequest = {"data":{"sink":"http://www.test.com","types":["it.fattureincloud.webhooks.entities.create","it.fattureincloud.webhooks.issued_documents.create"]}} // CreateWebhooksSubscriptionRequest |
apiInstance.createWebhooksSubscription(companyId, createWebhooksSubscriptionRequest).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (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 { Configuration, WebhooksApi } from '@fattureincloud/fattureincloud-ts-sdk';
// Configure OAuth2 access token for authorization:
const apiConfig = new Configuration({
accessToken: "YOUR ACCESS TOKEN"
});
let apiInstance = new WebhooksApi(apiConfig);
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: Not defined
GetWebhooksSubscriptionResponse getWebhooksSubscription(companyId, subscriptionId)
Get Webhooks Subscription
Get a webhooks subscription.
import { Configuration, WebhooksApi } from '@fattureincloud/fattureincloud-ts-sdk';
// Configure OAuth2 access token for authorization:
const apiConfig = new Configuration({
accessToken: "YOUR ACCESS TOKEN"
});
let apiInstance = new WebhooksApi(apiConfig);
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
apiInstance.getWebhooksSubscription(companyId, subscriptionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (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 { Configuration, WebhooksApi } from '@fattureincloud/fattureincloud-ts-sdk';
// Configure OAuth2 access token for authorization:
const apiConfig = new Configuration({
accessToken: "YOUR ACCESS TOKEN"
});
let apiInstance = new WebhooksApi(apiConfig);
let companyId = 12345; // Number | The ID of the company.
apiInstance.listWebhooksSubscriptions(companyId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (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 { Configuration, WebhooksApi , ModifyWebhooksSubscriptionRequest } from '@fattureincloud/fattureincloud-ts-sdk';
// Configure OAuth2 access token for authorization:
const apiConfig = new Configuration({
accessToken: "YOUR ACCESS TOKEN"
});
let apiInstance = new WebhooksApi(apiConfig);
let companyId = 12345; // Number | The ID of the company.
let subscriptionId = "SUB123"; // String | The ID of the subscription.
let modifyWebhooksSubscriptionRequest: ModifyWebhooksSubscriptionRequest = new FattureInCloudApiV2ApiReference.ModifyWebhooksSubscriptionRequest() // ModifyWebhooksSubscriptionRequest |
apiInstance.modifyWebhooksSubscription(companyId, subscriptionId, modifyWebhooksSubscriptionRequest).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (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