Conekta.net.Api.WebhookKeysApi

All URIs are relative to https://api.conekta.io

Method	HTTP request	Description
CreateWebhookKey	POST /webhook_keys	Create Webhook Key
DeleteWebhookKey	DELETE /webhook_keys/{id}	Delete Webhook key
GetWebhookKey	GET /webhook_keys/{id}	Get Webhook Key
GetWebhookKeys	GET /webhook_keys	Get List of Webhook Keys
UpdateWebhookKey	PUT /webhook_keys/{id}	Update Webhook Key

CreateWebhookKey

WebhookKeyCreateResponse CreateWebhookKey (string acceptLanguage = null, WebhookKeyRequest webhookKeyRequest = null)

Create Webhook Key

Create a webhook key

Example

using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;

namespace Example
{
    public class CreateWebhookKeyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.conekta.io";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new WebhookKeysApi(config);
            var acceptLanguage = es;  // string | Use for knowing which language to use (optional)  (default to es)
            var webhookKeyRequest = new WebhookKeyRequest(); // WebhookKeyRequest |  (optional) 

            try
            {
                // Create Webhook Key
                WebhookKeyCreateResponse result = apiInstance.CreateWebhookKey(acceptLanguage, webhookKeyRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookKeysApi.CreateWebhookKey: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateWebhookKeyWithHttpInfo variant

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

try
{
    // Create Webhook Key
    ApiResponse<WebhookKeyCreateResponse> response = apiInstance.CreateWebhookKeyWithHttpInfo(acceptLanguage, webhookKeyRequest);
    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 WebhookKeysApi.CreateWebhookKeyWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
acceptLanguage	string	Use for knowing which language to use	[optional] [default to es]
webhookKeyRequest	WebhookKeyRequest		[optional]

Return type

WebhookKeyCreateResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
401	authentication error	-
500	internal server error	-

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

DeleteWebhookKey

WebhookKeyDeleteResponse DeleteWebhookKey (string id, string acceptLanguage = null)

Delete Webhook key

Example

using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;

namespace Example
{
    public class DeleteWebhookKeyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.conekta.io";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new WebhookKeysApi(config);
            var id = 6307a60c41de27127515a575;  // string | Identifier of the resource
            var acceptLanguage = es;  // string | Use for knowing which language to use (optional)  (default to es)

            try
            {
                // Delete Webhook key
                WebhookKeyDeleteResponse result = apiInstance.DeleteWebhookKey(id, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookKeysApi.DeleteWebhookKey: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteWebhookKeyWithHttpInfo variant

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

try
{
    // Delete Webhook key
    ApiResponse<WebhookKeyDeleteResponse> response = apiInstance.DeleteWebhookKeyWithHttpInfo(id, acceptLanguage);
    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 WebhookKeysApi.DeleteWebhookKeyWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
acceptLanguage	string	Use for knowing which language to use	[optional] [default to es]

Return type

WebhookKeyDeleteResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
404	not found entity	-
500	internal server error	-

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

GetWebhookKey

WebhookKeyResponse GetWebhookKey (string id, string acceptLanguage = null, string xChildCompanyId = null)

Get Webhook Key

Example

using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;

namespace Example
{
    public class GetWebhookKeyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.conekta.io";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new WebhookKeysApi(config);
            var id = 6307a60c41de27127515a575;  // string | Identifier of the resource
            var acceptLanguage = es;  // string | Use for knowing which language to use (optional)  (default to es)
            var xChildCompanyId = 6441b6376b60c3a638da80af;  // string | In the case of a holding company, the company id of the child company to which will process the request. (optional) 

            try
            {
                // Get Webhook Key
                WebhookKeyResponse result = apiInstance.GetWebhookKey(id, acceptLanguage, xChildCompanyId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookKeysApi.GetWebhookKey: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetWebhookKeyWithHttpInfo variant

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

try
{
    // Get Webhook Key
    ApiResponse<WebhookKeyResponse> response = apiInstance.GetWebhookKeyWithHttpInfo(id, acceptLanguage, xChildCompanyId);
    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 WebhookKeysApi.GetWebhookKeyWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
acceptLanguage	string	Use for knowing which language to use	[optional] [default to es]
xChildCompanyId	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

WebhookKeyResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
404	not found entity	-
500	internal server error	-

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

GetWebhookKeys

GetWebhookKeysResponse GetWebhookKeys (string acceptLanguage = null, string xChildCompanyId = null, int? limit = null, string search = null, string next = null, string previous = null)

Get List of Webhook Keys

Consume the list of webhook keys you have

Example

using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;

namespace Example
{
    public class GetWebhookKeysExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.conekta.io";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new WebhookKeysApi(config);
            var acceptLanguage = es;  // string | Use for knowing which language to use (optional)  (default to es)
            var xChildCompanyId = 6441b6376b60c3a638da80af;  // string | In the case of a holding company, the company id of the child company to which will process the request. (optional) 
            var limit = 20;  // int? | The numbers of items to return, the maximum value is 250 (optional)  (default to 20)
            var search = "search_example";  // string | General order search, e.g. by mail, reference etc. (optional) 
            var next = "next_example";  // string | next page (optional) 
            var previous = "previous_example";  // string | previous page (optional) 

            try
            {
                // Get List of Webhook Keys
                GetWebhookKeysResponse result = apiInstance.GetWebhookKeys(acceptLanguage, xChildCompanyId, limit, search, next, previous);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookKeysApi.GetWebhookKeys: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetWebhookKeysWithHttpInfo variant

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

try
{
    // Get List of Webhook Keys
    ApiResponse<GetWebhookKeysResponse> response = apiInstance.GetWebhookKeysWithHttpInfo(acceptLanguage, xChildCompanyId, limit, search, next, previous);
    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 WebhookKeysApi.GetWebhookKeysWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
acceptLanguage	string	Use for knowing which language to use	[optional] [default to es]
xChildCompanyId	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]
limit	int?	The numbers of items to return, the maximum value is 250	[optional] [default to 20]
search	string	General order search, e.g. by mail, reference etc.	[optional]
next	string	next page	[optional]
previous	string	previous page	[optional]

Return type

GetWebhookKeysResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
500	internal server error	-

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

UpdateWebhookKey

WebhookKeyResponse UpdateWebhookKey (string id, string acceptLanguage = null, WebhookKeyUpdateRequest webhookKeyUpdateRequest = null)

Update Webhook Key

updates an existing webhook key

Example

using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;

namespace Example
{
    public class UpdateWebhookKeyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.conekta.io";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new WebhookKeysApi(config);
            var id = 6307a60c41de27127515a575;  // string | Identifier of the resource
            var acceptLanguage = es;  // string | Use for knowing which language to use (optional)  (default to es)
            var webhookKeyUpdateRequest = new WebhookKeyUpdateRequest(); // WebhookKeyUpdateRequest |  (optional) 

            try
            {
                // Update Webhook Key
                WebhookKeyResponse result = apiInstance.UpdateWebhookKey(id, acceptLanguage, webhookKeyUpdateRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WebhookKeysApi.UpdateWebhookKey: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateWebhookKeyWithHttpInfo variant

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

try
{
    // Update Webhook Key
    ApiResponse<WebhookKeyResponse> response = apiInstance.UpdateWebhookKeyWithHttpInfo(id, acceptLanguage, webhookKeyUpdateRequest);
    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 WebhookKeysApi.UpdateWebhookKeyWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
acceptLanguage	string	Use for knowing which language to use	[optional] [default to es]
webhookKeyUpdateRequest	WebhookKeyUpdateRequest		[optional]

Return type

WebhookKeyResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
404	not found entity	-
401	authentication error	-
500	internal server error	-

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

Files

WebhookKeysApi.md

Latest commit

History

WebhookKeysApi.md

File metadata and controls

Conekta.net.Api.WebhookKeysApi

CreateWebhookKey

Example

Using the CreateWebhookKeyWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteWebhookKey

Example

Using the DeleteWebhookKeyWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetWebhookKey

Example

Using the GetWebhookKeyWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetWebhookKeys

Example

Using the GetWebhookKeysWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateWebhookKey

Example

Using the UpdateWebhookKeyWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details