> ## Documentation Index
> Fetch the complete documentation index at: https://rollfi-monthly-semi-monthly.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

**Overview:** This section introduces our webhook system, which allows for real-time data transmission between our Payroll API and your application or service. Learn how to set up, manage, and troubleshoot your webhooks for optimal synchronization.

> **Note:**\
> You can find more webhook guidance and additional examples [here](https://developer.rollfi.xyz/docs/Webhooks).

**Configuring `subscribeWebhook`:** Use the `subscribeWebhook` endpoint to register your callback URL and select the webhook events you need.

**Example request structure**

1. `method`
   * Method type for the webhook. For this use case: `subscribeWebhook`.

2. `url`
   * The callback URL for the webhook. Example: `https://example.com/payroll-webhooks`.

**Onboarding and process responses**

```json theme={null}
{
    "onboarding": {
        "type": "company",
        "Id": "8A9B7683-8E02-494D-8422-963FD05EE785",
        "processStep": "KYB Verification",
        "nextProcessStep": "Link Bank Account",
        "state": "Successful",
        "message": "KYB Verfication was Successful",
        "eventTimeStamp": "2023-09-14T22:00:00.000Z"
    }
}

{
    "process": {
        "type": "payroll",
        "id": "8A9B7683-8E02-494D-8422-963FD05EE785",    
        "idType":"PayPeriodID",     
        "state": "Successful",
        "message": "Payroll was Successful for the Pay Period",
        "eventTimeStamp": "2023-09-14T22:00:00.000Z"
    }
}
```
