Flow

Webhook that notifies you whenever a flow instance is either successfully completed (FLOW_COMPLETED) or explicitly rejected (FLOW_REJECTED). Both share the same payload structure, with the main difference being the status field.

Overview

The Flow Status Webhook notifies your system about the final status of a flow instance once it has been processed, regardless of the result.
It provides the essential details to track whether the flow was successfully completed or rejected.

Webhook Trigger

Rillis sends a POST request to your configured webhook URL each time a flow reaches its final state.

Webhook Payload Schema

Parameter	Type	Description
id	String	Unique webhook event identifier.
type	String	Type of the event: `"FLOW_COMPLETED"` or `"FLOW_REJECTED"`.
timestamp	Number (timestamp)	Timestamp of the webhook event.
data.flow_instance_id	String	Unique identifier for the specific flow instance.
data.flow_id	String	ID of the flow definition.
data.user_id	String	ID of the user who completed or rejected the flow.
data.status	String	`"COMPLETED"` or `"REJECTED"`.
data.completed_at	String (ISO date)	When the flow reached its final status.
data.url	String	Reference URL for further details about the flow instance.

Status Differences

FLOW_COMPLETED:
Triggered when the entire flow and its services have been successfully completed.

FLOW_REJECTED:
Triggered when the flow is explicitly rejected during processing.

Example Webhook Payloads

Example: Flow Completed

{
  "id": "67a3be0fb928eb94fbb49e09",
  "type": "FLOW_COMPLETED",
  "timestamp": 1738784271042,
  "data": {
    "flow_instance_id": "67a3be04d236cd46c537c95d",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "COMPLETED",
    "completed_at": "2025-02-05T19:37:51.042Z",
    "url": "https://example.com/webhook"
  }
}

Example: Flow Rejected

{
  "id": "67a3cbc2b928eb94fbb49e0f",
  "type": "FLOW_REJECTED",
  "timestamp": 1738787778405,
  "data": {
    "flow_instance_id": "67a3cbb9d236cd46c537c9a8",
    "flow_id": "67a3af4ca59af345d61f4f9c",
    "user_id": "67a3a5065eee513d753f19b7",
    "status": "REJECTED",
    "completed_at": "2025-02-05T20:36:18.405Z",
    "url": "https://webhook.site/07eb6d44-791b-473f-bcac-dffc50c4f8e3"
  }
}

Flow

Overview#

Webhook Trigger#

Webhook Payload Schema#

Status Differences#

Example Webhook Payloads#

Example: Flow Completed#