All URIs are relative to https://api.smooch.io
Method | HTTP request | Description |
---|---|---|
createIntegration | POST /v2/apps/{appId}/integrations | Create Integration |
deleteIntegration | DELETE /v2/apps/{appId}/integrations/{integrationId} | Delete Integration |
getIntegration | GET /v2/apps/{appId}/integrations/{integrationId} | Get Integration |
listIntegrations | GET /v2/apps/{appId}/integrations | List Integrations |
updateIntegration | PATCH /v2/apps/{appId}/integrations/{integrationId} | Update Integration |
IntegrationResponse createIntegration(integration, appId)
Create Integration
The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks.
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.smooch.io");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("API_KEY_ID");
basicAuth.setPassword("API_KEY_SECRET");
// Uncomment this section to use JWTs instead
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT");
IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
Integration integration = new Integration(); // Integration |
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
// Add required body parameters
try {
IntegrationResponse result = apiInstance.createIntegration(integration, appId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsApi#createIntegration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
integration | Integration | ||
appId | String | Identifies the app. |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
400 | Invalid integration type | - |
Object deleteIntegration(appId, integrationId)
Delete Integration
Delete the specified integration.
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.smooch.io");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("API_KEY_ID");
basicAuth.setPassword("API_KEY_SECRET");
// Uncomment this section to use JWTs instead
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT");
IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
String integrationId = "029c31f25a21b47effd7be90"; // String | The id of the integration.
// Add required body parameters
try {
Object result = apiInstance.deleteIntegration(appId, integrationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsApi#deleteIntegration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
appId | String | Identifies the app. | |
integrationId | String | The id of the integration. |
Object
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Ok | - |
400 | SDK integrations configured on Admin Center cannot be deleted | - |
404 | Integration not found | - |
IntegrationResponse getIntegration(appId, integrationId)
Get Integration
Get integration.
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.smooch.io");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("API_KEY_ID");
basicAuth.setPassword("API_KEY_SECRET");
// Uncomment this section to use JWTs instead
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT");
IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
String integrationId = "029c31f25a21b47effd7be90"; // String | The id of the integration.
// Add required body parameters
try {
IntegrationResponse result = apiInstance.getIntegration(appId, integrationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsApi#getIntegration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
appId | String | Identifies the app. | |
integrationId | String | The id of the integration. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Ok | - |
404 | Integration not found | - |
IntegrationListResponse listIntegrations(appId, page, filter)
List Integrations
List available integrations. This API is paginated through cursor pagination. ```shell /v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web ```
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.smooch.io");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("API_KEY_ID");
basicAuth.setPassword("API_KEY_SECRET");
// Uncomment this section to use JWTs instead
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT");
IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
Page page = new Page(); // Page | Contains parameters for applying cursor pagination.
IntegrationListFilter filter = new IntegrationListFilter(); // IntegrationListFilter | Contains parameters for filtering the results.
// Add required body parameters
try {
IntegrationListResponse result = apiInstance.listIntegrations(appId, page, filter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsApi#listIntegrations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
appId | String | Identifies the app. | |
page | Page | Contains parameters for applying cursor pagination. | [optional] |
filter | IntegrationListFilter | Contains parameters for filtering the results. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Ok | - |
400 | Invalid query parameters | - |
IntegrationResponse updateIntegration(integrationUpdate, appId, integrationId)
Update Integration
Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data.
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.smooch.io");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("API_KEY_ID");
basicAuth.setPassword("API_KEY_SECRET");
// Uncomment this section to use JWTs instead
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT");
IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
IntegrationUpdate integrationUpdate = new IntegrationUpdate(); // IntegrationUpdate |
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
String integrationId = "029c31f25a21b47effd7be90"; // String | The id of the integration.
// Add required body parameters
try {
IntegrationResponse result = apiInstance.updateIntegration(integrationUpdate, appId, integrationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IntegrationsApi#updateIntegration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
integrationUpdate | IntegrationUpdate | ||
appId | String | Identifies the app. | |
integrationId | String | The id of the integration. |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Ok | - |
404 | Integration not found | - |