Skip to main content
GET
https://sajuapi.dev
/
v1
/
webhooks
/
{id}
웹훅 상세 조회
curl --request GET \
  --url https://sajuapi.dev/v1/webhooks/{id} \
  --header 'X-API-Key: <api-key>'
v1 Enterprise API (Coming Soon)이 엔드포인트는 Enterprise 버전에서 제공될 예정입니다. 현재는 v0 API를 사용하세요.
특정 웹훅의 상세 정보를 조회합니다. 최근 전송 기록과 실패 정보도 함께 반환됩니다.

​
Path 파라미터

​
id
string
required
조회할 웹훅의 ID입니다. whk_ 접두사로 시작합니다.

​
Query 파라미터

​
include_deliveries
boolean
default:"false"
최근 전송 기록을 포함할지 여부입니다. true면 최근 20건의 전송 기록이 포함됩니다.

​
Response

​
성공

웹훅 조회에 성공하면 Webhook 객체가 반환됩니다.

​
실패

상태 코드에러 타입설명
401authentication_errorAPI 키가 유효하지 않음
404not_found웹훅을 찾을 수 없음
429rate_limited요청 한도 초과

​
요청 예시

curl -X GET "https://api.sajuapi.dev/v1/webhooks/whk_abc123def456?include_deliveries=true" \
  -H "X-API-Key: bs_live_xxx"

​
응답 예시

{
  "id": "whk_abc123def456",
  "url": "https://your-server.com/webhooks/saju",
  "events": ["fortune.generated", "profile.created", "daily.reset"],
  "description": "운세 생성 알림",
  "metadata": {
    "environment": "production",
    "team": "backend"
  },
  "active": true,
  "failure_count": 0,
  "last_triggered_at": "2025-01-16T08:30:00Z",
  "created_at": "2025-01-15T09:00:00Z",
  "updated_at": "2025-01-15T09:00:00Z",
  "deliveries": [
    {
      "id": "dlv_xyz789",
      "event_type": "fortune.generated",
      "status": "success",
      "response_code": 200,
      "response_time_ms": 145,
      "attempted_at": "2025-01-16T08:30:00Z"
    },
    {
      "id": "dlv_abc456",
      "event_type": "profile.created",
      "status": "success",
      "response_code": 200,
      "response_time_ms": 89,
      "attempted_at": "2025-01-16T07:15:00Z"
    },
    {
      "id": "dlv_def123",
      "event_type": "daily.reset",
      "status": "success",
      "response_code": 200,
      "response_time_ms": 112,
      "attempted_at": "2025-01-16T00:00:00Z"
    }
  ],
  "statistics": {
    "total_deliveries": 156,
    "successful_deliveries": 154,
    "failed_deliveries": 2,
    "success_rate": 98.72,
    "average_response_time_ms": 125
  }
}

​
Webhook 객체

필드타입설명
idstring웹훅 ID입니다.
urlstring웹훅 수신 URL입니다.
eventsarray구독 중인 이벤트 목록입니다.
descriptionstring웹훅 설명입니다.
metadataobject메타데이터입니다.
activeboolean활성화 상태입니다.
failure_countinteger연속 실패 횟수입니다.
last_triggered_atstring마지막 트리거 시간입니다.
deliveriesarray최근 전송 기록입니다. include_deliveries=true일 때만 포함됩니다.
statisticsobject전송 통계입니다.

​
Delivery 객체

필드타입설명
idstring전송 ID입니다.
event_typestring이벤트 유형입니다.
statusstring전송 상태입니다. success, failed, pending 중 하나입니다.
response_codeintegerHTTP 응답 코드입니다.
response_time_msinteger응답 시간(밀리초)입니다.
error_messagestring실패 시 에러 메시지입니다.
attempted_atstring전송 시도 시간입니다.

​
자동 비활성화

웹훅이 연속 5회 이상 실패하면 자동으로 비활성화됩니다. 비활성화된 웹훅은 다음과 같이 표시됩니다. 
{
  "id": "whk_abc123def456",
  "active": false,
  "failure_count": 5,
  "disabled_reason": "consecutive_failures",
  "disabled_at": "2025-01-16T10:00:00Z"
}
웹훅을 다시 활성화하려면 웹훅 테스트 API를 사용하세요.