Skip to main content

FarEarth order completed source event

The configuration below shows an example of how to activate order completed events by including the orderCompletedConfig object.

{
    "id": "farearth.local-filesystem-triggers",
    "description": "Local filesystem trigger",
    "type": "filesystem",
    "orderCompletedConfig": {
        "filterStatus": ["FAILED"],
        "filterWorkflows": ["<insert workflow id>"]
    },
    "outputProperties": {
        "basePath": "c:/data/triggers",
    }
}

Filter status​

Within the orderCompletedConfig object, the filterStatus can either be omitted, or one or more of the following filters included:

  • SUCCESS include any order that was successful
  • CANCELLED include any order that was cancelled
  • FAILED include any order that failed

If filterStatus is omitted, all orders will result in an event being triggered.

Filter workflow​

You can specify a list of workflows in the filterWorkflows array. Events will only be triggered for workflows listed. If omitted, events will be triggered for all workflows in the current subscription.

Example event message​

Depending on the event output types, the format of the delivered event message might differ. However, the output will be similar to the example below.

note

The full canonical path to the archivedProducts will be provided (in this example a link to the asset in an Amazon-S3 bucket)

{
    "items" : [
        {
            "id" : "<farearth-order-id>",
            "correlationId" : "",
            "subscriptionId" : "farearth",
            "subscriptionTitle" : "FarEarth",
            "workflowId" : "<farearth-workflow-id>",
            "result" : "FAILED",
            "errorMessage" : "",
            "created" : 1769515698294,
            "started" : 1769515698356,
            "ended" : 1769516947203,
            "jobsTotal" : 7,
            "jobsFailed" : 1,
            "totalComputeTime" : 1216889,
            "bytesInput" : 86216739,
            "bytesPublished" : 361411604,
            "bytesArchived" : 118234718,
            "archivedProducts" : [
                "https://s3.af-south-1...20250521T124014_L1A_R1C1_product.json",
                "https://s3.af-south-1...20250521T124014_L0_R1C1_product.json" 
            ]
        }
    ]
}