GET STARTED

첫 이벤트를 보내기까지

채널에서 비밀 URL을 발급하고 외부 서비스가 JSON 메시지를 보내도록 구성하는 가장 짧은 경로입니다.

1. 웹훅 준비

  1. 1

    대상 채널 열기

    Briar의 대상 채널에서 수신 웹훅 관리 화면을 엽니다. 조직 소유자·관리자 또는 채널 소유자가 관리할 수 있습니다.

  2. 2

    이름 정하고 만들기

    메시지 작성자를 알아볼 수 있도록 ‘배포 알림’처럼 출처가 분명한 이름을 사용하세요.

  3. 3

    비밀 URL 즉시 보관

    생성된 전체 URL은 그 순간에만 표시됩니다. 비밀 관리 도구에 저장하고 코드, 이슈, 채팅이나 로그에 남기지 마세요.

2. 요청 구성

발급된 URL로 POST 요청을 보냅니다. 별도 Authorization 헤더는 없으며 URL 전체가 인증 정보입니다.

메서드
POST
엔드포인트
https://briar-api.wbai.workers.dev/hooks/channels/{webhook_id}/{secret}
Content-Type
application/json
최소 본문
{"text":"Production deployment completed."}

3. 공통 유의사항

URL을 자격 증명처럼 취급

URL을 아는 사람은 채널에 메시지를 보낼 수 있습니다. 노출이 의심되면 즉시 회전하세요.

재시도 키를 먼저 설계

한 이벤트를 다시 보낼 수 있다면 Idempotency-Key를 사용하고, 같은 논리적 이벤트의 모든 재시도에 같은 값을 유지하세요.

두 성공 상태를 모두 처리

새 메시지는 201, 이미 받은 이벤트는 200과 duplicate: true를 반환합니다. 둘 다 성공으로 처리하세요.

제한 안에서 전송

요청 본문은 64KiB 이하이며 text는 1~10,000자, blocks는 최대 50개입니다. 웹훅 하나당 60초에 최대 60회까지 요청할 수 있습니다.