WebhookApi

All URIs are relative to https://api.sendx.io/api/v1/rest

Method	HTTP request	Description
createWebhook	POST /webhook	Create webhook
deleteWebhook	DELETE /webhook/{identifier}	Delete webhook
getAllWebhooks	GET /webhook	Get all webhooks
getWebhook	GET /webhook/{identifier}	Get webhook by ID
updateWebhook	PUT /webhook/{identifier}	Update webhook

createWebhook

RestRWebhook createWebhook(restEWebhook)

Create webhook

Creates a new webhook for event notifications.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.WebhookApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    WebhookApi apiInstance = new WebhookApi(defaultClient);
    RestEWebhook restEWebhook = new RestEWebhook(); // RestEWebhook | 
    try {
      RestRWebhook result = apiInstance.createWebhook(restEWebhook);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhookApi#createWebhook");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
restEWebhook	RestEWebhook

Return type

RestRWebhook

Authorization

TeamApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	✅ Webhook created successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
403	❌ Forbidden - Resource name already exists	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-

deleteWebhook

DeleteResponse deleteWebhook(identifier)

Delete webhook

Deletes a webhook configuration. 🎯 Key Features: - Remove webhooks - Stop event delivery - Clean up endpoints

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.WebhookApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    WebhookApi apiInstance = new WebhookApi(defaultClient);
    String identifier = "identifier_example"; // String | Webhook identifier to update
    try {
      DeleteResponse result = apiInstance.deleteWebhook(identifier);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhookApi#deleteWebhook");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	Webhook identifier to update

Return type

DeleteResponse

Authorization

TeamApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	✅ Webhook deleted successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
404	❌ Not Found - Resource does not exist	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-

getAllWebhooks

List<RestRWebhook> getAllWebhooks()

Get all webhooks

Retrieves all configured webhooks.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.WebhookApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    WebhookApi apiInstance = new WebhookApi(defaultClient);
    try {
      List<RestRWebhook> result = apiInstance.getAllWebhooks();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhookApi#getAllWebhooks");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<RestRWebhook>

Authorization

TeamApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	✅ Webhooks retrieved successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
500	❌ Internal Server Error - System error occurred	-

getWebhook

RestRWebhook getWebhook(identifier)

Get webhook by ID

Retrieves details about a specific webhook.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.WebhookApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    WebhookApi apiInstance = new WebhookApi(defaultClient);
    String identifier = "identifier_example"; // String | Webhook identifier to retrieve
    try {
      RestRWebhook result = apiInstance.getWebhook(identifier);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhookApi#getWebhook");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	Webhook identifier to retrieve

Return type

RestRWebhook

Authorization

TeamApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	✅ Webhook retrieved successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
404	❌ Not Found - Resource does not exist	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-

updateWebhook

RestRWebhook updateWebhook(identifier, restEWebhook)

Update webhook

Updates webhook configuration.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.WebhookApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    WebhookApi apiInstance = new WebhookApi(defaultClient);
    String identifier = "identifier_example"; // String | Webhook identifier to update
    RestEWebhook restEWebhook = new RestEWebhook(); // RestEWebhook | 
    try {
      RestRWebhook result = apiInstance.updateWebhook(identifier, restEWebhook);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhookApi#updateWebhook");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	Webhook identifier to update
restEWebhook	RestEWebhook

Return type

RestRWebhook

Authorization

TeamApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	✅ Webhook updated successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
403	❌ Forbidden - Resource name already exists	-
404	❌ Not Found - Resource does not exist	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

WebhookApi

createWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAllWebhooks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

WebhookApi.md

Latest commit

History

WebhookApi.md

File metadata and controls

WebhookApi

createWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAllWebhooks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateWebhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details