Create documents with the Web Editor

The Pages (Web Editor) REST API lets your system open a document for editing or send data straight to PDF production. These features require Doxis Interact to be installed.

Every call needs a bearer token from a Standard API client. See Authentication.

Hosts and environments

Pages has two API hosts.

The pages in this part describe Pages v4, and the examples use its host. On Pages v3, use the Pages v3 host and check each call in the Pages v3 reference, which is linked from REST API.

Every path starts with the environment, for example /Development/dxml/create. The values are Development, Test, Test1, Test2, Test3, Test4, Test5, IntegrationTest, AcceptanceTest and Production. Most calls also take an optional last segment with an environment group name or id. Leave it out unless you work with environment groups.

A Pages environment can be set up to require an environment scope. A call to such an environment needs a token from a client that has that Webeditor Scope, otherwise it is refused. See Create an API client.

Base64

WebEditor will need document metadata to be in a Base64 string. There are online tools that will help you doing this (search the internet for Base64 XML) or you could write a small function that will do it for you.

This function is for Digital Ocean and will transform JSON input to a valid WebEditor XML before it is transformed into Base64:

const json2xml = require("json2xml")
const axios = require("axios")
 
async function main(args) 
{
  console.log(args);
 
      // keep this need to delete fro json body 
      delete args.http
      delete args.__ow_headers
      delete args.__ow_path
      delete args.__ow_method
      // keep this need to delete fro json body
    
      Object.keys(args).forEach(k => !args[k] && delete args[k])
      
      const xmlver = "<?xml version='1.0' encoding='utf-8'?>"
 
      const xmlData = xmlver + "<Data>" + json2xml(args) + "</Data>";
      const base64Data = Buffer.from(xmlData).toString('base64');     
 
    return {"body": base64Data } 
}
 
exports.main=main

XML Sample data

You will need to construct some XML data with input elements that are used in the Interact template. This is one example:

<?xml version='1.0' encoding='utf-8'?>
<Data>
    <Contact
        ContactAccountId="0012o00002OkJbTAAV"
        ContactAccountName__c="Dickenson plc"
        ContactAssistantName="Marie Curie"
        ContactAssistantPhone="(785) 265-5350"
        ContactBirthdate="2000-09-20"
        ContactCleanStatus="Pending"
        ContactCount__c="123"
        ContactDepartment="Internal Operations"
        ContactDescription="(785) 265-5350"
        ContactDoNotCall="false"
        ContactEmail="a_young@dickenson.com"
        ContactFax="1234567"
        ContactFirstName="Andy"
        ContactHasOptedOutOfEmail="false"
        ContactHasOptedOutOfFax="false"
        ContactHomePhone="(524) 232.2123"
        ContactId="0032o00002WtQjkAAF"
        ContactIsEmailBounced="false" 
    />
</Data>

Once you have managed to create a XML and converted it to Base64 you are ready to use the API to create documents

DXML

If you would like to create a document that can be edited, you will need to create a DXML. When creating a DXML you will get a link that will start an edit session for the document.

API Call: https://api.webeditor-v4.metaforce.net/Development/dxml/create

For data as JSON instead of XML, call /{customerEnvironment}/dxml/create/jsondata. The body is the same.

Example of body parameters in Postman:

{
    "username" : "User",
    "DataAsBase64": "PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0ndXRmLTgnPz4KPERhdGEgREVTQ1JJUFRJT049XRhPg==// TRUNCATED// ",
    "Document": "CaseLetter1",
    "MetaFile": "CompanyLetters"
}

Sample response:

{
  "DxmlUID": "c8dda6d7-b137-4a3f-ae1c-e46db95482a1",
  "StartURL": "https://<Pages host>/WebEditor/0alIQV0R4KFP4I30r33qjiDFmKr57E%2BlU9e%2B8fpTgGXBRnjuuJ9QtzJbV9HoH59LBAUc6nOeCqXcbNfsThIOlM%2Frv%2B3MwUpm3f318Y2LbA0qw3GwCuhCNp2qgozLlUgUVPkBscSLfcBfMXyVi7OdLA%3D%3D",
  "ValidTo": "2026-09-10T05:54:47.6835658Z"
}

• DxmlUID identifies the session. Keep it, because every follow-up call uses it.
• StartURL opens the editor. By copying it into the browser you start a Web Editor session to edit the document.
• ValidTo is when the session is deleted. The document is editable until then. The retention policy controls this date.
• JWT appears only when Require JWT Authentication is turned on for your company. Add it to the end of the start URL as StartURL?jwt=JWT to start the session.

A call can also answer 204, when the data should not produce a document, or 406, when the data cannot be produced because logic is missing in the MetaFile.

Attachments

Each attachment in Attachments has:

Attachments works on the DXML and data calls on this page and on PDF and other outputs. The HTML calls take no attachments.

To look up attachments that are published in your MetaFiles, call POST /{customerEnvironment}/attachments. Send Top, the largest number of hits you want. It is required. You can add Id for an exact match and Name, Description or Group for a partial match. Fields you leave out are not used. Each hit has Id, Name, Group, Description, MetaLogic, DocumentName, SaveTime and UserID.

{
    "Top": 10,
    "Group": "Letters"
}

Callback

If you set SenderCallBackEndpoint, Doc Gen makes a GET request to it when the editing is finished. The request adds the DXML id and a status. For https://sample.endpoint.com it looks like this:

https://sample.endpoint.com/0D2FF9B5-BFE6-4999-9C66-945881806D18?Status=OK

Status is OK or Discarded. A session that is still a draft when maintenance deletes it gives Status=Deleted. If you set a user name and password, the request carries them as a Basic authorization header, so you can protect the endpoint.

When editing is finished you can use the DxmlUID to recreate the PDF from the Web Editor session with GET /{customerEnvironment}/pdf/dxml/{dxmlUID}. See PDF and other outputs.

PDF

Based on metadata you can create a PDF directly from Doxis Interact with this REST API call: https://api.webeditor-v4.metaforce.net/Development/pdf/create

Example of body parameters in Postman:

{
    "username" : "User",
    "DataAsBase64": "PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0ndXRmLTgnPz4KPERhdGEgREVTQ1JJUFRJT049XRhPg==// TRUNCATED// ",
    "Document": "CaseLetter2 - Online",
    "MetaFile": "CompanyLetters"
}

This function will return the actual PDF that can be stored or view as you like. The other output formats are on PDF and other outputs.

Follow a session

The status of a session is Draft, OK, Discarded or Deleted. All of these calls start with /{customerEnvironment}.

Manage the DXML file

Look up what the MetaFile holds