POST https://test-api.finerworks.com/v3/add_event

Add Event Log

Creates an event log entry that can be reviewed later for debugging purposes. This endpoint requires special permission to use.

Body

Name	Description	Type	Additional information
id	Event log id. It should be null when logging an event. After the event is sent through the add_event endpoint, this will be updated and returned to the user.	number	None.
type	This can be be "error", "warning", "success", or "other". If none of these values are used then the type will be "other".	text	None.
name	Custom name	text	Required Max length: 50
details	Contain details of the event.	text	Required
account_id	Optional account id of user that caused the event if known.	number	None.
site_id	This should be a single digit number: 1 for FinerWorks, 2 for EZCanvas and 3 for GeoGalleries	number	Required Range: inclusive between 1 and 3
date_time	This should be left null if logging event. After the event is sent through the add_event endpoint, this will be populated.	date	None.

Example JSON Body

application/json, text/json

{
  "id": 1,
  "type": "sample string 2",
  "name": "sample string 3",
  "details": "sample string 4",
  "account_id": 5,
  "site_id": 6,
  "date_time": "2026-07-30T16:20:48.6686494-05:00"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/add_event' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "id": 1,
  "type": "sample string 2",
  "name": "sample string 3",
  "details": "sample string 4",
  "account_id": 5,
  "site_id": 6,
  "date_time": "2026-07-30T16:20:48.6686494-05:00"
}'

require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/add_event');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
    'follow_redirects' => TRUE
));
$request->setHeader(array(
    'Content-Type' => 'application/json',
    'web_api_key' => 'my-web-api-key-goes-here',
    'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'id': 1,
  'type': 'sample string 2',
  'name': 'sample string 3',
  'details': 'sample string 4',
  'account_id': 5,
  'site_id': 6,
  'date_time': '2026-07-30T16:20:48.6686494-05:00'
}');
try {
    $response = $request->send();
    if ($response->getStatus() == 200) {
        echo $response->getBody();
    }
    else {
        echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
            $response->getReasonPhrase();
    }
}
catch(HTTP_Request2_Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://test-api.finerworks.com/v3/add_event");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'id': 1,
  'type': 'sample string 2',
  'name': 'sample string 3',
  'details': 'sample string 4',
  'account_id': 5,
  'site_id': 6,
  'date_time': '2026-07-30T16:20:48.6686494-05:00'
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

var settings = {
    "url": "https://test-api.finerworks.com/v3/add_event",
    "method": "POST",
    "timeout": 0,
    "headers": {
        "Content-Type": "application/json",
        "web_api_key": "my-web-api-key-goes-here",
        "app_key": "my-app-key-goes-here"
    },
    "data": JSON.stringify({
  'id': 1,
  'type': 'sample string 2',
  'name': 'sample string 3',
  'details': 'sample string 4',
  'account_id': 5,
  'site_id': 6,
  'date_time': '2026-07-30T16:20:48.6686494-05:00'
}),
};

$.ajax(settings).done(function (response) {
    console.log(response);
});

var https = require('follow-redirects').https;

var options = {
    'method': 'POST',
    'hostname': 'test-api.finerworks.com',
    'path': '/v3/add_event',
    'headers': {
        'Content-Type': 'application/json',
        'web_api_key': 'my-web-api-key-goes-here',
        'app_key': 'my-app-key-goes-here'
    },
    'maxRedirects': 20
};

var req = https.request(options, function (res) {
    var chunks = [];
    res.on("data", function (chunk) { chunks.push(chunk); });
    res.on("end", function () {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });
    res.on("error", function (error) { console.error(error); });
});

var postData = JSON.stringify({
  'id': 1,
  'type': 'sample string 2',
  'name': 'sample string 3',
  'details': 'sample string 4',
  'account_id': 5,
  'site_id': 6,
  'date_time': '2026-07-30T16:20:48.6686494-05:00'
});

req.write(postData);
req.end();

require "uri"
require "net/http"

url = URI("https://test-api.finerworks.com/v3/add_event")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
  'id': 1,
  'type': 'sample string 2',
  'name': 'sample string 3',
  'details': 'sample string 4',
  'account_id': 5,
  'site_id': 6,
  'date_time': '2026-07-30T16:20:48.6686494-05:00'
}"

response = https.request(request)
puts response.read_body

Name	Description	Type	Additional information
event_log	Event log object	event_log	None.
status	Response status details	response_status	None.

Example JSON Response

application/json, text/json

{
  "event_log": {
    "id": 1,
    "type": "sample string 2",
    "name": "sample string 3",
    "details": "sample string 4",
    "account_id": 5,
    "site_id": 6,
    "date_time": "2026-07-30T16:20:48.6686494-05:00"
  },
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {},
    "reference_id": "sample string 4",
    "domain": "sample string 5"
  }
}