엔드포인트

endpoint = client.webhooks.create(  url: "https://acme.com/hooks/mail",  eventTypes: ["email.sent", "email.bounced"],  description: "Billing service") File.write(".openemail-webhook-secret", endpoint[:secret]) client.webhooks.listclient.webhooks.get(endpoint[:id])client.webhooks.update(endpoint[:id], enabled: false)client.webhooks.test(endpoint[:id])latest = client.webhooks.list_deliveries(endpoint[:id], limit: 1).items.firstclient.webhooks.get_delivery(endpoint[:id], latest[:id])client.webhooks.replay_delivery(endpoint[:id], latest[:id])rotated = client.webhooks.rotate_secret(endpoint[:id])File.write(".openemail-webhook-secret", rotated[:secret])client.webhooks.delete(endpoint[:id])

시크릿이 반환되는 것은 rotate_secret을 빼면 create 때뿐입니다. 읽기 호출은 절대 시크릿을 되돌려주지 않으므로, 다른 일을 하기 전에 먼저 저장하세요. eventTypes를 생략하면 기본 집합, 즉 email.replied를 제외한 모든 email.* 이벤트를 받습니다. email.replied, domain.*, suppression.*, file.*, form.*는 엔드포인트가 이를 명시할 때만 전달됩니다.

OpenEmail::WEBHOOK_EVENTS는 모든 이벤트 이름을 담은 동결된 Hash이므로 요청 없이 목록을 렌더링할 수 있으며, webhooks.list_events는 같은 이름을 각각의 설명 문장, 그리고 엔드포인트에 적용되는 한도와 함께 반환합니다. 이 이벤트는 이 API의 이벤트가 아니라 **메일함**의 이벤트입니다: email.received는 앱에 메일이 도착할 때 발생하고, email.sent는 작성기가 메시지를 보냈을 때 발생합니다. 구독하는 것은 자신의 API 트래픽을 지켜보는 것과 다릅니다.

file.uploaded는 파일이 파일 페이지에 올라갈 때, file.deleted는 파일이 삭제될 때 발생합니다. 그 data는 fileId, filename, mimeType, sizeBytes, direction, to, threadId, messageId, 그리고 uploadedAt 또는 deletedAt을 담습니다. to는 파일이 속한 주소이고, 워크스페이스 전체에 속한 파일이면 nil입니다.

form.submitted는 누군가 내 양식 중 하나로 가입할 때 발생하고, form.confirmed는 그 사람이 확인 링크를 열었거나 내가 승인해서 확인 대기 중인 가입이 오디언스에 들어갈 때 발생합니다. form.submitted의 data에는 formId, formName, submissionId, email, status, answers, audienceIds, sourceUrl, submittedAt이 들어 있습니다. form.confirmed의 data에는 formId, formName, submissionId, email, audienceIds, link 또는 approval인 via, 그리고 confirmedAt이 들어 있습니다.

result = client.webhooks.test("whe_3f9c2a7b1e4d8f60a5c7b92d")puts result.dig(:delivery, :status), result.dig(:delivery, :responseCode) client.webhooks.iterate_deliveries("whe_3f9c2a7b1e4d8f60a5c7b92d") do |delivery|  puts "#{delivery[:eventType]} #{delivery[:status]} #{delivery[:responseCode]} #{delivery[:error]}"end

test는 서명된 합성 email.sent 이벤트를 POST하고 시도가 끝날 때까지 기다립니다. 수신 측이 무엇을 응답하든 정상적으로 반환되므로, 호출이 예외를 발생시켰는지가 아니라 delivery[:status]로 분기하세요. 4xx는 유용한 답입니다: URL에 닿을 수 있고, 거부는 여러분 자신의 핸들러, 흔히 그 서명 검사에서 왔다는 뜻이기 때문입니다.

detail = client.webhooks.get_delivery("whe_3f9c2a7b1e4d8f60a5c7b92d", "whd_8c1e4a7f2b9d3e6a0c5f1b28")p detail[:payload], detail[:responseBody], detail[:replayRefusal] replay = client.webhooks.replay_delivery("whe_3f9c2a7b1e4d8f60a5c7b92d", "whd_8c1e4a7f2b9d3e6a0c5f1b28")p replay.dig(:delivery, :status), replay.dig(:delivery, :responseCode)

계속 실패하는 전달은 최대 8번 시도합니다. 즉시, 그리고 1분, 5분, 30분, 2시간, 5시간, 10시간, 다시 10시간 뒤이며, 모두 합쳐 약 27시간 반입니다. 반복할 가치가 있는 실패만 반복합니다. 응답 없음, 408, 425, 429, 5xx가 여기에 해당합니다. 재전송은 저장된 이벤트를 같은 id, type, createdAt, data로 다시 보내므로, 이미 처리한 id를 버리는 수신 측은 이를 이미 아는 이벤트로 취급합니다. 새로 바뀌는 것은 서명뿐입니다.

• —replay_delivery는 이벤트 하나를 지금 보내고 서버가 응답한 내용을 반환합니다. 전달에 성공한 시도에도 쓸 수 있고, 절대 재시도되지 않습니다. 보내기 전에 그 이벤트의 자동 재시도 가운데 아직 시작되지 않은 것은 일시 중지됩니다: 재전송이 전달되면 계속 취소된 상태로 남고, 실패하면 예정대로 다시 진행됩니다.
• —그 순간 같은 이벤트의 자동 재시도가 전송 중이면 replay_delivery는 아무것도 보내지 않고 409 retry_in_progress를 발생시키고, 같은 이벤트의 다른 재전송이 아직 전송 중이면 409 replay_in_progress를 발생시키므로, 같은 순간에 보낸 두 재전송이라도 수신 측이 동시에 두 개를 받는 일은 없습니다. 몇 초 기다린 뒤 get_delivery를 확인하세요. 그 재시도나 재전송으로 전달될 수 있습니다. 재전송은 한 번에 이벤트 하나입니다: 실패한 전달을 모두 다시 보내는 호출은 없습니다.
• —또한 꺼진 엔드포인트(webhook_disabled), 엔드포인트가 더 이상 구독하지 않는 이벤트(event_not_subscribed)나 더 이상 포함하지 않는 이벤트(event_out_of_scope), 저장된 이벤트가 없는 시도(delivery_not_replayable)에도 409를 발생시킵니다. get_delivery는 그 결과를 replayRefusal로 미리 알려 줍니다.

Symbol 키를 가진 Hash입니다. get, list, update는 secret이 없는 같은 형태를 반환합니다.

failed = client.webhooks.list_workspace_deliveries(status: "failed", since: Time.now - 86_400)p failed.items.map { |delivery| [delivery[:endpointId], delivery[:eventType], delivery[:responseCode]] } history = client.webhooks.list_activity("whe_3f9c2a7b1e4d8f60a5c7b92d")p history.items.map { |change| [change[:type], change.dig(:actor, :label)] }

list_deliveries는 엔드포인트 하나를, list_workspace_deliveries는 모든 엔드포인트나 endpoint_ids:로 지정한 것을 읽으며, 둘 다 콘솔 전송 탭의 필터인 status:, since:, until:을 받습니다. list_activity와 list_workspace_activity는 감사 로그를 읽습니다: 누가 무엇을 만들고, 바꾸고, 끄거나 켜고, 교체하고, 테스트하고, 재전송하고, 삭제했는지. 각각 옆에 list_all_과 iterate_ 버전이 있고, 워크스페이스 로그의 모든 행에는 endpointId가 붙습니다. webhooks.stats는 원하는 기간에 대해 분석 탭 뒤에 있는 숫자를 반환합니다.