Release 27

Release 27 Feature Improvements

TrueNCOA API Improvements

All improvements listed below can be viewed in our API Documentation: https://truencoa.com/postman-documentation.

API Support for JSON

TrueNCOA now supports JSON when you POST data to the API. Including JSON, allows you some flexibility in how your data is uploaded.

We have included samples within our API documentation called:

  • Id - Upload Data - Single Record json
  • Id - Upload Data - Bulk json
  • Name - Create file and Upload Data - Single Record json
  • Name - Create file and Upload Data - Bulk json

Webhooks

TrueNCOA's API now supports webhooks during your standard file processing. Webhooks were already available for update file notifications.

To include a webhook on a file, you'll need to include the paramater url=[webhook_url] when you are uploading data. Including a webhook url when you post data will allow our API to send a notification to your API when your data has finished processing. This prevents you from having to continually poll the API. When you include the webhook url, this call's response will include your webhook url, and it will also be listed on the file display page in the UI.

We have included samples within our API documentation called:

  • Id - Upload Data - Bulk with webhook
  • Id - Upload Data - Bulk json with webhook
  • Name - Create File and Upload Data - Bulk with webhook
  • Name - Create file and Upload Data - Bulk json with webhook

New API Call

We have added a new API call that combines the Submit File call and Create Export call. This call is named Submit File with Template.

To use this API call, create your file and upload your data as you normally would. (We recommend including a webhook during your upload data call!) When you are ready to submit your data for processing, use the Submit File with Template call to submit your file for processing and have TrueNCOA automatically create an export file.

This call requires you to define the export template you would like to use on your export file. We have included this sample within our API documentation.

 

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.