How to: Add new events

To create a new event output, or edit an existing event, follow these steps.

Prerequisites

• You need to have the Admin role in FarEarth

Step 1

• Navigate to the EVENT OUTPUTS page

Step 2

• Click CREATE EVENT OUTPUT

Step 3

• Enter the following required fields:

Field	Details
App	The FarEarth application ID where the event output will be created
Description	A short description of the event output
ID	A unique ID for the event output
Type	The protocol type of the event output

Step 4

• Click CREATE
• After creating the event output, FarEarth will add additional fields automatically to the event output

Field	Details
Enabled	Controls whether the event output is enabled or not
File Name	The JSON filename of the event output as stored on disk
Shareable	Controls whether the event output may be shared with other subscriptions
Exclusive	Limits the event output to be shareable with only one subscription

Step 5

• The new event output will appear in the list. The event output is pre-populated with a template that requires further editing

note

More details about these fields are provided in the event sources and event output types sections below

Edit event output

• To edit the event output, click on FILE NAME in the list

This is an example of an empty event configuration:

{
    "id": "farearth.example",
    "description": "example",
    "type": "filesystem",
    "orderCompletedConfig": {        
    },
    "outputProperties": {
    }
}

Optional configuration values

The following optional properties are available:

Field	Details
deactivated	Whether the output is deactivated and offline. Default is false
retries	The number of times the output should be attempted to be written. Default is 5
backoffDelay	The number of milliseconds that should be waited before retrying. Default is 1000

Example event output

The following shows an example of a configuration for Amazon Simple Queue Service (Amazon SQS) that listens for failed orders.

{
    "id": "farearth.sqs-events",
    "description": "SQS triggers",
    "type": "amazon-sqs",
    "orderCompletedConfig": {
        "filterStatus": ["FAILED"],
        "filterWorkflows": ["<insert workflow id>"]
    },
    "outputProperties": {
        "region": "eu-west-2",
        "accessKey": "<insert access key>",
        "secretKey": "<insert secret key>",
        "queueUrl": "https://sqs.eu-west-2.amazonaws.com/.../farearthqueue",
    }
}

Expected outcome

• Outcome #1

Related links

• Related links #1
• Related links #2