Delivery Channel JSON Definition

Transact Manager allows you to create and configure a delivery channel for an organization. A delivery channel configuration is different for each delivery method. More information about delivery channels is available starting with Create a Delivery Channel.

Example

An example Deliver Channel definition file is shown below.

delivery-def.json

{
    "name": "REST Delivery",
    "deliveryMethod": "REST Service",
    "defaultChannel": true,
    "retryDelayMins": 15
}

Schema

Delivery Channel definitions must comply with the following schema.

Fields are optional unless otherwise indicated.

Field	Description
name	string Required. The name used to identify the Delivery Channel.
description	string A brief description of the Delivery Channel.
deliveryMethod	string Required. Must be one of the following: "Delivery Process" "REST Service"
defaultChannel	boolean Configure this delivery channel as the default channel for the organization. Forms that don't have a delivery channel configured will use the default channel.
retryDelayMins	integer The period to wait before retrying a failed delivery. Only applies if deliveryMethod is "Delivery Process".
serviceName	string Only applies if deliveryMethod is "Delivery Process".