Heimdall

Tema

Webhooks ​

Integrasikan Heimdall dengan sistem eksternal via webhooks. Heimdall akan mengirim HTTP POST ke URL yang Anda konfigurasikan saat event tertentu terjadi.

Configuration ​

Tambahkan webhook di dashboard Heimdall atau via API:

json
{
  "webhook": {
    "url": "https://your-server.com/webhook/heimdall",
    "events": ["test.completed", "test.failed", "baseline.created"],
    "secret": "your-webhook-secret"
  }
}

Event Types ​

EventTriggerPayload
test.startedTest execution dimulaiexecutionId, testCaseId
test.completedTest execution selesaiexecutionId, result, duration
test.failedTest execution gagalexecutionId, errors
baseline.createdBaseline screenshot dibuattestCaseId, baselineId
baseline.updatedBaseline screenshot diupdatetestCaseId, baselineId
device.connectedDevice baru terhubungdeviceId, model
device.disconnectedDevice terputusdeviceId
healing.triggeredSelf-healing aktifexecutionId, originalSelector

Payload Examples ​

test.completed ​

json
{
  "event": "test.completed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "executionId": "exec-12345",
    "testCaseId": "tc-login-001",
    "result": "passed",
    "duration": "00:01:23",
    "platform": "android",
    "deviceId": "emulator-5554"
  }
}

healing.triggered ​

json
{
  "event": "healing.triggered",
  "timestamp": "2024-01-15T10:31:00Z",
  "data": {
    "executionId": "exec-12345",
    "originalSelector": "text:Login",
    "healedSelector": "id:btn_login",
    "strategy": "resource_id",
    "confidence": 0.95
  }
}

Security ​

Signature Verification ​

Setiap request webhook memiliki header X-Heimdall-Signature:

python
import hmac
import hashlib

signature = hmac.new(
    secret.encode('utf-8'),
    payload.encode('utf-8'),
    hashlib.sha256
).hexdigest()

# Verify against X-Heimdall-Signature header
if hmac.compare_digest(signature, request.headers['X-Heimdall-Signature']):
    process_webhook(payload)

Best Practices ​

  • Selalu verifikasi signature
  • Return HTTP 200 dengan cepat
  • Proses payload secara async
  • Implement retry logic di sisi Heimdall

Troubleshooting ​

Webhook not firing ​

  • Check URL dapat diakses publik
  • Verify event type benar
  • Check secret sesuai

Invalid signature ​

  • Ensure secret tidak berubah
  • Check encoding UTF-8
  • Verify timestamp tidak expired