Create an integration

You can use a POST request to create a new integration on a tenant. To complete this request, you must have:

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

Examples

For help with creating specific integrations, use the following examples:

Request

Sample request

The request below creates an integration on the tenant:

curl -X POST -H "Content-Type: application/json"
https://api.cxengage.net/v1/tenants/<tenantId>
/integrations/ -d '{
	"attribute": {
            "type": "<type>",
            "name": "<name>",
            "active": "true",
            "properties": {
			"":""
			"":""			
		     }
			"active":false
}'

Request parameters

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

Parameter	Required	Type	Description
tenantId	yes	UUID	The tenant’s unique identifier.
type	yes	string	Identifies the integration when it is used in a flow object. Options include: Salesforce REST API Zendesk
active	yes	boolean	Enter true to enable the integration and make the integration visible in the Flow Designer.
properties	yes	object	An array of attributes that enable CxEngage to authenticate to the third-party service. For information about the expected attributes for each integration type, see Examples.

Response

Sample response

The request returns JSON structured like the example below:

{
  "result":{
    "tenantId":"",
    "properties":{
				"":""
				"":""			
				 },
    "createdBy":"",
    "updated":"",
    "type":"",
    "created":"",
    "updatedBy":"",
    "active":false,
    "id":""
  }
}

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. For information about the expected attributes for each integration type, see Examples.
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	string	The date and time, in UTC format, when the integration was created.
updatedBy	UUID	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.