How to: Implement Custom Code in Participant Services

implementing pre configured custom code the pre configured custom code url is available for each api that supports custom code the custom code will be registered and configured for a type like https //docs getos1 com/reference/register custom code configurations of a participant type developers can configure the custom code for create instance , update instance , and apply event implementing custom code in the request body to dynamically modify the custom code config for each api call, we've added two https //docs getos1 com/custom code#fzh0t it can be used for creating, updating, and applying requests custom code fields to add custom code in the https //docs getos1 com/participant add the following values in the request body name type description url string request url for the custom code api call requestheader object default headers for custom code api call method string http method type of api request for custom code (post/put/get) wait boolean wait for the response from the api call acceptablestatuscodes array acceptable status codes raiseerroronstatusmismatch boolean raise an error if the status code returned doesn’t match acceptablestatuscodes methodname string type of action (for create, update, or apply) and onrequest or onerror 📘 methodnames allowed are create\ onrequest , create\ onerror , update\ onrequest , update\ onerror , apply event\ onrequest , apply event\ onerror here is a sample payload of custom code with methodname apply event\ onrequest { "url" "https //www test com", "requestbody" {}, "requestheader" { "x coreos access" "{{token}}", "x coreos request id" "{{request id}}", "x coreos tid" "{{tenant id}}", "x coreos userinfo" { "id" "test1", "name" "customcode" } }, "method" "get", "wait" true, "methodname" "apply event\ onrequest" } expected response from custom code data is expected in response to the custom code with the existing payload in the data fields { data { 	 } } data formation from custom code response the fields returned from custom code inside the data field are replaced with the existing payload as shown below the payload in request body { "uniquecode" "code1", "name" "mobile", "owner" "delhivery", "properties" { "count" 10, "color" "blue" }, "callback" { "url" "http //examplecallback com" } } payload from custom code returned { "properties" { "count" 120 }, "callback" { "url" "https //delhivery test com/test", "meta" { "source" "coreos" } } } final payload that is used to register an instance { "uniquecode" "code1", "name" "mobile test", "owner" "delhivery", "properties" { "count" 120 }, "callback" { "url" "https //delhivery test com/test", "meta" { "source" "coreos" } } } restriction on fields in custom code response for different apis in custom code, there are a few restrictions on what data keys are not acceptable for particular api types we have provided the list below for the developers to know more here is the markdown table api type values not accepted in data keys values accepted in data keys create instance uniquecodeownerappidentitytypepluralnamet propertiescallbackcategorysubcategory update instance uniquecodeownerappidentitytypepluralname propertiescallback apply event uniquecodeownerappidentitytypepluralname eventcodereasoncode how to retrieve custom code details in participant service to retrieve the details of the configured custom code in participant service, call the https //docs getos1 com/reference/get custom code configurations of a participant type endpoint and pass the custom code id in the path parameter