Merge and Deliver via Webhook
Purpose
To send or post the merged document to the given webhook URL.
HTTP Request URL
https://{api.office-integrator_domain}/writer/officeapi/v1/document/merge/webhook
Request Parameters
Parameter | Value | Description |
Mandatory Parameters | ||
apikey | 423s****** | Uniquely identifies the web application in which the Writer editor is integrated. |
Body Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
output_format | String | Supported formats are pdf or docx. Specify a format in which you would like to download the merged document. |
file_content or file_url | File or String | Below are the methods to provide the input file that needs to merged with the data depending on its location. file_content - if the input file is from your local drive or desktop. file_url - if the input file is from a publicly accessible Web URL. |
webhook | { "invoke_url" : <url>, "invoke_period": "oneveryrecord/oncomplete" } | Pass the values for invoke_url and invoke_period via this parameter as JSON. Provide the webhook url in which the merged documents needs to be posted in invoke_url and when the merged documents needs to be posted in invoke_period. |
merge_to | String | Supported merge types are separatedoc and singledoc. Specify in which type you would like to merge the document. separatedoc - If you would like to merge each record as a separate document. singledoc- If you would like to merge all the records as a single document. |
You can provide the data in any one of the below formats | ||
merge_data | JSONObject | Pass a String value through 'data' key as JSON Array. |
merge_data_csv_content | File | Provide the required csv content in your API request body. |
merge_data_json_content | File | Provide the required json content in your API request body. |
merge_data_csv_url | url | Provide the required csv url in your API request body. |
merge_data_json_url | url | Provide the required json url in your API request body. |
Optional Parameters | ||
password | String | Specify a password if you would like to protect the merged document. |
webhook
Parameter | Type | Possible Values | Default Value |
invoke_url | string | URL | URL |
invoke_period | string | oncomplete and oneveryrecord. oncomplete - If you would like to post the merged documents after merging all the records. oneveryrecord - If you would like to post the merged document of each record once done. | oncomplete |