Generic server delivery integration

Delivery integrations provide data to third-party systems after a document is generated. The Generic server delivery integration sends document info to a third-party app, allowing it to fetch the document with another call. The app responds with the URI for Create to navigate the user to upon successful delivery. By default, Create navigates the user back to the overview.

The generic server delivery integration is set up with the following parameters:

• Name
  • A name for the integration to make it easily identifiable.
• Authentication
  • Identification type.
  • None, Static header, WSO2, OAuth2, OAuth2ClientCredentials
  • Each type except None requires its own parameters.
• Delivery Endpoint URI
  • Where to deliver the data to.
• Static Header Key
• Static Header Value

Create makes a POST request of the following format:

{
  "documentUri": "",
  "documentType": "",
  "recipeId": ""
}

The properties are:

• documentUri
  • Where to fetch the generated document from.
• documentType
  • "Document" or "Element".
• recipeId
  • The ID of the recipe used to generate the document.

The following response body is expected:

{
  "navigateToUri": ""
}

• navigateToUri
  • The URI where the user should be navigated to upon successful delivery.