Webhooks Overview

The Flow API provides two types of webhook to help you stay updated on the progress and completion of verification and onboarding flows:

1️⃣ General Flow Webhooks

These webhooks are configured at the flow level and notify you when a flow has been fully completed, including all the associated services.
You can configure these webhooks when creating or editing a flow by clicking the "<>" button (with the tooltip "Integrate SDK") as shown in the following image:

Here, simply enter the URL of your webhook endpoint and click Save. Once configured, Rillis will automatically send notifications to this URL every time a user completes the flow.

2️⃣ Step-by-Step Webhooks

If you want to receive more granular updates as the user progresses through the different steps of the flow (such as onboarding forms or document verification), you can enable step-specific webhooks.
These can be configured by navigating to the "Webhook" tab within each flow. This way, you can capture events as they occur in real-time while the user completes each step. For example, in the image we can see the webhooks of the identity verification step.

Summary Table of Flow API Webhooks

Webhook Type	Description	Step
`FLOW_COMPLETED`	Triggered when a flow and all related services are fully completed.	Flow completion
`FLOW_REJECTED`	Triggered when a flow is rejected (e.g., final decision of no approval).	Flow completion
`VERIFICATION_IDENTITY_REJECTED`	Triggered when an identity verification is rejected.	Identity Verification
`VERIFICATION_IDENTITY_COMPLETED`	Triggered when an identity verification is approved.	Identity Verification
`VERIFICATION_IDENTITY_UPDATED`	Triggered when an identity verification is manually updated.	Identity Verification
`ONBOARDING_FORM_INDIVIDUAL_COMPLETED`	Triggered when an individual onboarding form is completed (pending review).	Onboarding Individual
`ONBOARDING_FORM_INDIVIDUAL_REJECTED`	Triggered when an individual onboarding form is rejected.	Onboarding Individual
`ONBOARDING_FORM_COMPANY_COMPLETED`	Triggered when a company onboarding form is completed (pending review or approved).	Onboarding Company
`ONBOARDING_FORM_COMPANY_REJECTED`	Triggered when a company onboarding form is rejected.	Onboarding Company

How Webhooks Work

Whenever an event occurs (like the completion of a flow or a step update), Rillis sends a POST request to your configured webhook URL containing the event data in JSON format. The payload typically includes:

type: The type of the event (e.g., FLOW_COMPLETED, VERIFICATION_IDENTITY_COMPLETED).

timestamp: The time when the event was triggered.

data: The specific details of the event.

For a complete breakdown of each webhook type and its payload structure, check out the dedicated documentation page for each webhook event.

💡 Note: Your webhook endpoint must respond with a 200 HTTP status code to confirm receipt. If Rillis does not receive this response, it will automatically retry the notification several times to ensure successful delivery.

Webhooks Overview

1️⃣ General Flow Webhooks#

2️⃣ Step-by-Step Webhooks#

Summary Table of Flow API Webhooks#

How Webhooks Work#

1️⃣ General Flow Webhooks

2️⃣ Step-by-Step Webhooks

Summary Table of Flow API Webhooks

How Webhooks Work