Invoicetronic.Sdk.Api.WebhookApi

All URIs are relative to https://api.invoicetronic.com

Method	HTTP request	Description
WebhookGet	GET /webhook	List webhooks
WebhookIdDelete	DELETE /webhook/{id}	Delete a webhook by id
WebhookIdGet	GET /webhook/{id}	Get a webhook by id
WebhookPost	POST /webhook	Add a webhook
WebhookPut	PUT /webhook	Update a webhook
WebhookhistoryGet	GET /webhookhistory	List webhook history items
WebhookhistoryIdGet	GET /webhookhistory/{id}	Get a webhook history item by id

WebhookGet

List<WebHook> WebhookGet (int? companyId = null, int? page = null, int? pageSize = null, string sort = null, string description = null, bool? enabled = null, string events = null, string url = null)

List webhooks

Retrieve a paginated list of webhooks. Results can be filtered by company, description, enabled status, events, and URL. Webhooks allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the Dashboard. A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (enabled set to false) and the account owner is notified by email. To resume deliveries, set enabled back to true from the Dashboard or via PATCH /webhook/{id}. For more information, see the Webhooks documentation page.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var companyId = 56;  // int? | Company id (optional) 
            var page = 1;  // int? | Page number. (optional)  (default to 1)
            var pageSize = 100;  // int? | Items per page. Cannot be greater than 200. (optional)  (default to 100)
            var sort = "sort_example";  // string | Sort by field. Prefix with '-' for descending order. (optional) 
            var description = "description_example";  // string |  (optional) 
            var enabled = true;  // bool? |  (optional) 
            var events = "events_example";  // string |  (optional) 
            var url = "url_example";  // string |  (optional) 

            try
            {
                // List webhooks
                List<WebHook> result = apiInstance.WebhookGet(companyId, page, pageSize, sort, description, enabled, events, url);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookGetWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List webhooks
    ApiResponse<List<WebHook>> response = apiInstance.WebhookGetWithHttpInfo(companyId, page, pageSize, sort, description, enabled, events, url);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
companyId	int?	Company id	[optional]
page	int?	Page number.	[optional] [default to 1]
pageSize	int?	Items per page. Cannot be greater than 200.	[optional] [default to 100]
sort	string	Sort by field. Prefix with '-' for descending order.	[optional]
description	string		[optional]
enabled	bool?		[optional]
events	string		[optional]
url	string		[optional]

Return type

List<WebHook>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookIdDelete

WebHook WebhookIdDelete (int id)

Delete a webhook by id

Delete a webhook subscription by its internal id. Webhooks allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the Dashboard. A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (enabled set to false) and the account owner is notified by email. To resume deliveries, set enabled back to true from the Dashboard or via PATCH /webhook/{id}. For more information, see the Webhooks documentation page.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookIdDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var id = 56;  // int | Item id

            try
            {
                // Delete a webhook by id
                WebHook result = apiInstance.WebhookIdDelete(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookIdDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookIdDeleteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete a webhook by id
    ApiResponse<WebHook> response = apiInstance.WebhookIdDeleteWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookIdDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	int	Item id

Return type

WebHook

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookIdGet

WebHook WebhookIdGet (int id)

Get a webhook by id

Retrieve a webhook by its internal id. Webhooks allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the Dashboard. A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (enabled set to false) and the account owner is notified by email. To resume deliveries, set enabled back to true from the Dashboard or via PATCH /webhook/{id}. For more information, see the Webhooks documentation page.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookIdGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var id = 56;  // int | Item id

            try
            {
                // Get a webhook by id
                WebHook result = apiInstance.WebhookIdGet(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookIdGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookIdGetWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get a webhook by id
    ApiResponse<WebHook> response = apiInstance.WebhookIdGetWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookIdGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	int	Item id

Return type

WebHook

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookPost

WebHook WebhookPost (WebHook webHook)

Add a webhook

Create a new webhook subscription. Webhooks allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the Dashboard. A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (enabled set to false) and the account owner is notified by email. To resume deliveries, set enabled back to true from the Dashboard or via PATCH /webhook/{id}. For more information, see the Webhooks documentation page.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var webHook = new WebHook(); // WebHook | 

            try
            {
                // Add a webhook
                WebHook result = apiInstance.WebhookPost(webHook);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookPostWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Add a webhook
    ApiResponse<WebHook> response = apiInstance.WebhookPostWithHttpInfo(webHook);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
webHook	WebHook

Return type

WebHook

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookPut

WebHook WebhookPut (WebHook webHook)

Update a webhook

Update an existing webhook subscription. Webhooks allow you to receive notifications to an external service when specific events occur, such as invoice creation or status updates. You can subscribe to specific events and receive a notification when they occur. You can also manage webhooks via the Dashboard. A webhook that fails continuously for 7 days (no successful delivery in between) is automatically disabled (enabled set to false) and the account owner is notified by email. To resume deliveries, set enabled back to true from the Dashboard or via PATCH /webhook/{id}. For more information, see the Webhooks documentation page.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var webHook = new WebHook(); // WebHook | 

            try
            {
                // Update a webhook
                WebHook result = apiInstance.WebhookPut(webHook);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookPut: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookPutWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update a webhook
    ApiResponse<WebHook> response = apiInstance.WebhookPutWithHttpInfo(webHook);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookPutWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
webHook	WebHook

Return type

WebHook

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
422	Unprocessable Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookhistoryGet

List<WebHookHistory> WebhookhistoryGet (int? page = null, int? pageSize = null, string sort = null, int? webhookId = null)

List webhook history items

Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookhistoryGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var page = 1;  // int? | Page number. (optional)  (default to 1)
            var pageSize = 100;  // int? | Items per page. Cannot be greater than 200. (optional)  (default to 100)
            var sort = "sort_example";  // string | Sort by field. Prefix with '-' for descending order. (optional) 
            var webhookId = 56;  // int? | WebHook id (optional) 

            try
            {
                // List webhook history items
                List<WebHookHistory> result = apiInstance.WebhookhistoryGet(page, pageSize, sort, webhookId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookhistoryGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookhistoryGetWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List webhook history items
    ApiResponse<List<WebHookHistory>> response = apiInstance.WebhookhistoryGetWithHttpInfo(page, pageSize, sort, webhookId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookhistoryGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
page	int?	Page number.	[optional] [default to 1]
pageSize	int?	Items per page. Cannot be greater than 200.	[optional] [default to 100]
sort	string	Sort by field. Prefix with '-' for descending order.	[optional]
webhookId	int?	WebHook id	[optional]

Return type

List<WebHookHistory>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WebhookhistoryIdGet

WebHookHistory WebhookhistoryIdGet (int id)

Get a webhook history item by id

Webhook history items are stored in the database and can be accessed via the API. They are preserved for 15 in both the live and sandbox environments.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Invoicetronic.Sdk.Api;
using Invoicetronic.Sdk.Client;
using Invoicetronic.Sdk.Model;

namespace Example
{
    public class WebhookhistoryIdGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.invoicetronic.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new WebhookApi(httpClient, config, httpClientHandler);
            var id = 56;  // int | Item id

            try
            {
                // Get a webhook history item by id
                WebHookHistory result = apiInstance.WebhookhistoryIdGet(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookApi.WebhookhistoryIdGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WebhookhistoryIdGetWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get a webhook history item by id
    ApiResponse<WebHookHistory> response = apiInstance.WebhookhistoryIdGetWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling WebhookApi.WebhookhistoryIdGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	int	Item id

Return type

WebHookHistory

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

WebhookApi.md

Latest commit

History

WebhookApi.md

File metadata and controls

Invoicetronic.Sdk.Api.WebhookApi

WebhookGet

Example

Using the WebhookGetWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookIdDelete

Example

Using the WebhookIdDeleteWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookIdGet

Example

Using the WebhookIdGetWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookPost

Example

Using the WebhookPostWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookPut

Example

Using the WebhookPutWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookhistoryGet

Example

Using the WebhookhistoryGetWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WebhookhistoryIdGet

Example

Using the WebhookhistoryIdGetWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details