Example: Creating a Zendesk integration

This example demonstrates how to use a POST request to create a Zendesk integration using the REST API. To complete this request, you must have:

  • MANAGE_ALL_PROVIDERS
  • An account with the service you want to integrate and account credentials for that service

Request

Sample request

The request below creates a Zendesk integration on the tenant:

curl -X POST -H "Content-Type: application/json"
https://api.cxengage.net/v1/tenants/<tenantId>
/integrations/<integrationId> -d '{
	"attributes": {
            "type": "Zendesk",
            "name": "Sample Zendesk Integration",
            "active": "true",
            "properties": {
		"endpointPrefix": "",
             "interactionFieldId": "",
                "password": "",
                "username": "",
                "workItems": false			     }
			"active":false
}'

Request parameters

The table below lists the parameters you can include in a request:

Parameter Required Type Description
tenantId true UUID The unique identifier of the tenant.
type true string The type of integration. Enter zendesk.
active true boolean Enter true to enable the integration and make the integration visible in the Flow Designer.
properties true object

An array of attributes that enable CxEngage to authenticate to the third-party service.For a Zendesk integration, include the following:

  • endpointPrefix
  • interactionFieldId (optional)
  • password
  • username
  • workItems

Response

Sample response

The request returns JSON structured like the example below:

{
            "tenantId": "7d23df20-2461-11e7-9bf4-b883f2d63b7b",
            "description": null,
            "properties": {
                "endpointPrefix": "",
                "interactionFieldId": "",
                "password": "",
                "username": "",
                "workItems": false
            },
            "createdBy": "cd6e8140-adc6-11e6-8e76-e898003f3411",
            "updated": "2017-04-18T18:04:38Z",
            "name": "zendesk",
            "type": "zendesk",
            "created": "2017-04-18T18:04:38Z",
            "updatedBy": "cd6e8140-adc6-11e6-8e76-e898003f3411",
            "active": false,
            "id": "7d28e830-2461-11e7-9bf4-b883f2d63b7b"
        },

Response parameters

The response includes the following parameters:

Parameter Type Description
tenantId UUID The unique identifier of the tenant.
properties array

An array of attributes that enable CxEngage to authenticate to the third-party service.
createdBy UUID The unique identifier of the user who created the integration.
updated string The date and time, in UTC format, when the integration was last updated.
type string The type of integration.
created UUID The date and time, in UTC format, when the integration was created.
updatedBy string The unique identifier of the user who last updated the integration.
active boolean A flag indicating whether or not the integration is enabled and visible in the Flow Designer.
id UUID The integration's unique identifier.