Implement JSON Template Configuration for 'Post to URL' Workflow Task

Current System Behavior:

The existing 'Post to URL' workflow task allows for the posting of single data records as query parameters within the body request. This method of sending query parameters within the body is not typically associated with POST requests and offers limited data formatting options and may not align with the requirements of various third-party systems.

Issue Encountered:

The current implementation restricts data transmission to a query string format, which may not be suitable for all third-party integrations.

The use of query parameters in a POST request is unconventional and leads to integration challenges.

Example of Current Implementation:

Request host: example.com.au

Request URL: /

Request body: targeturl=https%3A%2F%2Fexample.com.au&contactID=99419199&contactName=Example+Name&eventType=updated

Proposed Enhancement:

Implement of a JSON template to allow data options and format to be set in the body.

Example :

{  
"contact": {  
   "email": "johndoe@example.com",
   "firstName": "John",
   "lastName": "Doe",
    "phone": "7223224241",
    "fieldValues": [{
                      "field": "contactID",
                      "value": 99419199
                   }]
             }
}

Feature Description:

Introduce the ability to configure a JSON template within the 'Post to URL' workflow task.

This feature will enable RTOs, to format the data being posted to third-party systems in a JSON structure, a widely accepted format for data interchange and controll the data being sent.

Benefits:

Increased Data Options:

Allowing the full data object (in this example the Contact object) or parts of to included would offer enhanced integration capabilities and reduce the requirements to follow the POST request with a API call to retrieve the data object and reduce loads on aXcelerates system.

Flexibility in Data Formatting:

Allows for more complex data structures and hierarchies, enhancing the integration capabilities with various third-party systems.

Standardisation:

Aligns with common web practices, as JSON is one of the standard formats for POST requests.

Improved Data Integrity:

Reduces the risk of data misinterpretation by third-party systems, ensuring accurate and reliable data exchange.

Use Case:

An RTO wishes to integrate aXcelerate with a third-party system that requires data in a specific JSON format. The enhanced 'Post to URL' function will allow the RTO to define a JSON template, ensuring that the data is correctly structured and understood by the third-party system.

Implementation Considerations:

The user interface for template configuration should be intuitive and accessible to users with varying technical expertise.

Adequate validation and error handling mechanisms should be in place to ensure the integrity of the JSON format.

Documentation and examples should be provided to assist users in setting up and utilising the new feature effectively.

Conclusion:

This enhancement will significantly improve the versatility and effectiveness of the 'Post to URL' workflow task in aXcelerate, facilitating smoother and more efficient integrations with a wide range of third-party systems. Also allowing a greater level of integration with other systems.

Official comment

Jack Christensen

10 April 2025 23:59

Hey Chris,

I believe you are already aware, but Webhooks are going into a full release as part of our release next week. Documentation is here:

https://support.axcelerate.com.au/hc/en-gb/articles/12411698043791-Webhooks

Thanks,
Jack

Rod Staines

31 January 2024 03:25

Hi Chris,

Thank you for your submission here.

Although not exactly as you have suggested, we are close to having a true webhook system for developers to leverage.

At this stage, the payload you receive will still only have limited data relating to the object (i.e. contactID for contact), but it will be in JSON format.

We will likely do a limited release of the system, so if you would like to be involved I can reach out when we're ready?

Cheers,
Rod.

Chris Joyce

31 January 2024 03:27

Yes please

Implement JSON Template Configuration for 'Post to URL' Workflow Task

Comments

Didn't find what you were looking for?