Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
action_notification_exports
Action Notification Exports

Create Action Notification Export

Create Action Notification Export

post/action_notification_exports

Response

The ActionNotificationExports object.

idinteger

History Export ID

export_versionstring

Version of the underlying records for the export.

start_atstring date-time

Start date/time of export range.

end_atstring date-time

End date/time of export range.

statusstring

Status of export. Valid values: building, ready, or failed

query_pathstring

Return notifications that were triggered by actions on this specific path.

query_folderstring

Return notifications that were triggered by actions in this folder.

query_messagestring

Error message associated with the request, if any.

query_request_methodstring

The HTTP request method used by the webhook.

query_request_urlstring

The target webhook URL.

query_statusstring

The HTTP status returned from the server in response to the webhook request.

query_successboolean

true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

results_urlstring

If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.

Example response

{
  "id": 1,
  "export_version": "20201213.2",
  "start_at": "2000-01-01T01:00:00Z",
  "end_at": "2000-01-01T01:00:00Z",
  "status": "ready",
  "query_path": "MyFile.txt",
  "query_folder": "MyFolder",
  "query_message": "Connection Refused",
  "query_request_method": "GET",
  "query_request_url": "http://example.com/webhook",
  "query_status": "200",
  "query_success": true,
  "results_url": "https://files.com/action_notification_results.csv"
}