Sitecore Connect/Workato Webhooks offer a powerful way to integrate Sitecore with external systems for seamless, real-time data exchange and event-driven automation. However, there are cases where customizing the webhook response becomes essential. For example, you may need the webhook to return a 201 Created status code or a custom JSON format (e.g., OrderCloud Pre-hook). Unfortunately, Sitecore Connect/Workato Webhooks default to a 200 OK response, and changing this isn’t always straightforward.
To address basic customizations, such as altering the response code or sending an empty response, Workato provides workato_response_code and workato_empty_response parameters, as detailed in Webhooks trigger configuration | Workato Docs
Returning a custom response body, however, requires more than webhook adjustments. Here, the new API Platform can help, offering a versatile way to set up API Endpoints that allow precise response customization. In this blog, I’ll guide you through creating an API Endpoint on Workato’s API Platform to return a custom response body.
NOTE: The API Platform is an add-on to Sitecore Connect and may require additional licensing. Please reach out to your CSM to confirm access.
Steps to Create an API Endpoint with Custom Response in Sitecore Connect
- Build a New API Recipe
- Create a recipe with an API Request trigger and a Return action from the API Platform.
- Configure the Request & Response headers, define the schema, and set the desired status code(s) within the API Request trigger to make these options available in the Return action.
- Start the Recipe.
- Create a recipe with an API Request trigger and a Return action from the API Platform.
- Create an API Collection
- Navigate to Tools -> API Platform.
- Create a new Collection.
- Select API recipe collection option
- Choose the above created Recipe’s folder/project
- Validate the Endpoint(s) autogenerated from the selected Recipe(s)
- Specify a name for the collection and create the collection
- Configure the API Collection
- Enable the endpoint by activating it and saving the settings.
- Go to the Clients tab of API Platform, create a new client, and provide a name.
- Create an access profile for the created client by selecting an authentication method (mandatory for API Collections), as Sitecore Connect/Workato does not support no-auth or query string-based authentication.
- Assign the client to your API collection for secure access to the endpoint, without which API Endpoint might not be accessible.
- Validate, Monitor and Optimize
- Test the endpoint using a tool like Postman or curl to confirm proper functionality
- Monitor endpoint performance in the API Platform dashboard and configure alerts if desired
Following these steps, you can confidently set up API Endpoints that deliver the precise response your workflows need, expanding Sitecore Connect’s automation capabilities and giving you complete control over your integrations.