Signal Triggers

List of public endpoints for managing and triggering signals

Processes can contain a specific type of robot called Await Signal. This robot will wait for a signal from an external system before allowing the process to proceed. Signals can contain data, which can then be used in subsequent steps in your process. This page summarizes the API endpoints for managing and triggering signals.

Dont forget to include the Authorization and X-Organization headers in every request. They have been omitted from these endpoints for brevity.

Index

GET https://api.seliom.com/signals

Returns the list of signals stored for a specific process template. Every element in the list is the Signal ID.

Query Parameters

Name	Type	Description
template_uuid	string	UUID of the process template

200

{
    "signals": ['AWAIT_SIGNED_DOCUMENT']
}

Show

GET https://api.seliom.com/signals/:signal_id

Returns all the data necessary to trigger the signal.

Path Parameters

Name	Type	Description
signal_id	string	ID of the signal

Query Parameters

Name	Type	Description
template_uuid	string	UUID of the process template that contains the signal

200

{
    "submission_elements": [
        {
            "definition_element": {
                label: "Employee Name",
                type: "text",
                name: "employee_name",
                exit_type: "text",
                required: true
            }
        }
    ]
}

Trigger a Signal Event

POST https://api.seliom.com/signals

Triggers the specified signal by sending an event with the signal's required data.

Request Body

Name	Type	Description
submission_elements	array	Form elements required to trigger the signal
process_instance_uuid	string	ID of the process instance (case) that is waiting for the signal.
signal_id	string	ID of the signal to trigger

200

{
    "message": "Signal event triggered successfully"
}