Integrations 🛠️

TerseFlow checklists can connect to other services in a variety of ways, as well as allow custom integrations

Integrations are 🛠️Coming Soon (Q3 2021) to TerseFlow. Here's what you can expect in its inital release, but this may change

Integrations require a Business Plan

Webhooks

TerseFlow will allow for a webhook to be triggered when something occurs on a checklist run - e.g. a run is started, completed, or a step is changed.

Configuring the Endpoint

You can configure the endpoint in the 'Webhook' section, under Workspace Settings (requires Admin)..

The endpoint MUST be an SSL endpoint, with a signed certificate.

Endpoint Failure

If a webhook fails to trigger, it will be retried once after one minute and then permanently failed. Anyone with Admin privileges on the workspace will receive an email only for the first permanent failure per day.

Webhook Format

A webhook is triggered when any of the following situations occur:

• A run is:

  • Started

  • Completed

  • Reopened

• A step is

  • Checked off

  • Unchecked

If your endpoint returns a 3xx redirect code, TerseFlow will follow it up to two redirects. If you redirect more times, or your server returns anything other than a 2xx or 3xx code, the webhook will be considered a failure (see Endpoint Failure)

Run Callback

When one of the run-related triggers occur, the following will be sent to your endpoint via POST request

{
    "workspace_id": 0000000000,
    "hook_type": "run",
    "checklist": {
        "checklist_id": 00000000
        "run": {
            "run_id": 00000000,
            "user_id": 00000000,
            "state": "started"
            "datetime": 000000000
        }
    }
}

• user_id corresponds to the user who triggered the action

• datetime is in UNIX timestamp format

• state can be one of started, completed, reopened

Step Callback

When one of the step-related triggers occur, the following will be sent to your endpoint via POST request

{
    "workspace_id": 0000000000,
    "hook_type": "step",
    "checklist": {
        "checklist_id": 00000000
        "run": {
            "run_id": 00000000,
            "step": {
                "user_id": 00000000,
                "state": "checked"
                "date": $TIMESTAMP
            }            
        }
    }
}

• user_id corresponds to the user who triggered the action

• datetime is in UNIX timestamp format

• state can be one of checked, unchecked

Ready to Integrate TerseFlow into Your Business?