Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Function: Basic cURL POST

    March 16, 2025
    + 12

    Goal: Perform a simple cURL POST using an external REST endpoint.

    • This function basicCurlPost communicates with a public REST echo service.

    • Requires Eventing Storage (or metadata collection) and a "source" collection.

    • Needs a Binding of type URL Alias (as documented in the Scriptlet).

    • Will operate on any mutation of the KEY "make_curl_request::1".

    • The actual cURL request from the Eventing Function will be equivalent to (but test to make sure the service is live):

      shell
      Copy
      curl -q 'https://postman-echo.com/post' -d '{ "myboolean": true }'

    • Only logs the REST response JSON payload to the Application log file.

    javascript
    Copy
    // To run configure the settings for this Function, basicCurlPost, as follows:
//
// Version 7.1+
//   "Function Scope"
//     *.* (or try bulk.data if non-privileged)
// Version 7.0+
//   "Listen to Location"
//     bulk.data.source
//   "Eventing Storage"
//     rr100.eventing.metadata
//   Binding(s)
//    1. "binding type", "alias name...",   "URL...",                    "misc.",
//       "URL alias",    "curlEchoApi",     "https://postman-echo.com/", "no auth"
//
// Version 6.X
//   "Source Bucket"
//     source
//   "MetaData Bucket"
//     metadata
//   Binding(s)
//    1. "binding type", "alias name...",   "URL...",                    "misc.",
//       "URL alias",    "curlEchoApi",     "https://postman-echo.com/", "no auth"


function OnUpdate(doc, meta) {
    // You would typically filter to mutations of interest
    if (meta.id !== 'make_curl_request::1') return;
    try {
        // only make a cURL POST request we see a mutation on the above KEY
        var request = {
            path: 'post',   // can also do 'get' in this API
            body: {
                "myboolean": true
            }
        };
        //  perform the cURL request using the URL alias from the settings
        var response = curl('POST', curlEchoApi, request);
        if (response.status != 200 && response.status != 302) {
            log("cURL POST failed response.status:",response.status)
        } else {
            log("cURL POST success, response.body:",response.body)
            // optional write to a bucket - requires a binding alias in settings
            // note the response.body.json is the echo back of request.body
            // dst_col[meta.id] = response.body;
        }
    } catch (e) {
        log("cURL request had an exception:",e)
    }
}