Skip to main content

Uniphore Customer Portal

Add Export Endpoints

Use the create export endpoints request to add a new export endpoint to the system. To add a storage location endpoint see Add Storage Location Endpoints.

Endpoint

Method: POST

URL: /policy/endpoint/createOrUpdate

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

userID

String

The user ID of the user with permission to create new endpoints.

Required

tenantId

String

The ID of the tenant to add an export endpoint to.

Required

endpointDetails

Array

A list of parameters that set the details of the export endpoint to add, consisting of the following parameters in this table.

Required

endpoint

Array

Set the system details for the endpoint, see endpoint Sub-parameters for further details.

Required

uri

String

Set the address of the Webhook or Socket export endpoint uses to export to.

Required

uriAuthHeader

String

Set the authorization header to use during export.

Optional

requestTimeout

Number

Set the number of seconds allowed for exporting content, after which the export will fail. This is only taken into account after an initial export fails. Defaults to 100 seconds if not set.

Optional

allowInsecureCertificate

Boolean

Determine the required certificate security during exports to this Endpoint. Set to true to allow uncertified certificates during exports to this Endpoint. Set to false to require certifies certificated during exports to this endpoint.

Required

certificateHash

String

Set the hash to the certificate which allows exports to this endpoint.

Optional

bearerTokenAuthorization or credentialsGrantAuthorization or noAuthorization

Array

Set the details used to obtain an access token for exporting to the endpoint, either by bearer token or credentials grant. If no authorization is needed for the endpoint then use noAuthorization.

If bearerTokenAuthorization is to be used, enter the following parameters in the array:

  • token - The token to use to obtain an access token for export.

  • authorizationEndpoint - The address or IP of the Authorization Endpoint to use to obtain an access token for export.

  • clientId - The client ID to use to obtain an access token for export.

If credentialsGrantAuthorization is to be used, enter the following parameters in the array:

  • clientId - The client ID to use to obtain access to the export location.

  • clientSecret - The client secret to use to obtain access to the export location.

  • scope - The scope used to obtain access to the export location.

  • authorizationEndpoint - The address or IP of the Authorization Endpoint to use to obtain access to the export location.

Required

For an example request, see Sample Request.

endpoint Sub-parameters

Parameter Name

Data Type

Description

Required/Optional

name

String

Set the friendly name for the export endpoint.

Required

description

String

Add a useful description for the export endpoint.

Optional

exportChannel

Array

Set the details for the export channel for the endpoint, for export endpoints the options are:

Post call export:

  • channelName - Webhook

  • exportChannelId - 1

Real-Time Export:

  • channelName - Socket

  • exportChannelId - 3

Required

Response and Error Code

Response Code

Condition

201

Created

Request Parameter

Parameter Name

Data Type

Description

endpointDetailsId

Integer

The automatically generated ID of the newly created export endpoint.

for an example response see Sample Response.

Sample Request
{
"userId":"auth0|735ujf53h235bn09835d984h",
"tenantId":"67hg8362-g3d2-7g92-9273-d9h02kr83736",
"endpointDetails":{
	"endpoint":{
		"name":"WriterExampleWebhookEndpoint2",
		"description":"WriterExampleWebhookEndpoint",
		"exportChannel":{
			"channelName":"Webhook",
			"exportChannelId":1
		}
	},
	"uri":"https://webhook.site/29b16487-1911-4dfb-a495-68cf16b3826c",
	"uriAuthHeader":"ExampleHeader",
	"requestTimeout":30,
	"allowInsecureCertificate":false,
	"certificateHash":"5",
	"bearerTokenAuthorization":{
		"authorizationEndpoint":"/zaff",
		"token":"67jh458k-ljp2-87d9-56tl-3th7s76a689k",
		"clientId":"abcd-1234"
		}
	}
}
Sample Response
{
    "endpointDetailsId": "8197"
}

In this section: