> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bitrace.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Bitrace API service offers a Webhook feature that allows users to receive event notifications.

### Async Task Workflow

```mermaid theme={null}
sequenceDiagram
    participant HTTP Client
    participant API Service
    participant Webhooks Service

    HTTP Client->>API Service: Send Request
    API Service-->>HTTP Client: Response with requestId

    alt HTTP Client Polling
        loop Check for Result
            HTTP Client->>API Service: Get Result by requestId
            API Service-->>HTTP Client: Response with Result
        end
    else Webhooks Service Push
        API Service->>Webhooks Service: Send Response
        Webhooks Service-->>HTTP Client: Push Result to Client
    end
```

### Webhooks Event Fields

<ResponseField name="webhookId" type="string" required>
  The unique identifier for the webhook.
</ResponseField>

<ResponseField name="eventType" type="string" required>
  Type of event that triggered the webhook.
</ResponseField>

<ResponseField name="timestamp" type="string" required>
  Timestamp indicating when the event occurred
</ResponseField>

<ResponseField name="data" type="object" required>
  The data related to this event
</ResponseField>

#### Event Example

```json theme={null}
{
  "webhookId":"60944883389642198713019658195148",
  "data":{
    "dirData":{
      "in":{
        "default-kyt":{
          "strategyNo":"default-kyt",
          "strategyName":"default",
          "score":"22.27626",
          "details":[
            {
              "score":"22.27626",
              "code":"hack",
              "name":"Hacking"
            }
          ]
        },
        "default_62680284809793536_86437582530844820316382104768774":{
          "strategyNo":"default_62680284809793536_86437582530844820316382104768774",
          "strategyName":"3 hop｜All type ｜1% or 5000",
          "score":"22.27626",
          "details":[
            {
              "score":"22.27626",
              "code":"hack",
              "name":"Hacking"
            }
          ]
        }
      },
      "out":{

      }
    },
    "requestId":"60944883389642198713019658195148",
    "maxScore":"22.27626",
    "customId":"123456",
    "status":1003
  },
  "eventType":"getTxHashCustomRiskScore",
  "timestamp":"2025-05-29 11:25:23"
}
```