Overview

루니버스는 현재 API를 통한 Webhook의 생성, 조회, 수정, 삭제를 지원하고 있습니다. 추후 업데이트를 통해 콘솔을 통한 Webhook 관리가 가능하며, Custom Webhook 등의 기능이 추가로 함께 제공될 예정입니다.

Webhook을 사용하기 위해서는 가장 먼저 createWebhook API를 활용하여 Webhook을 생성해야 합니다. Webhook에서 지원하는 이벤트 타입 및 타입별 생성 요청 예제는 Webhook Types 페이지를 참고해주세요. 모든 Webhook은 생성과 동시에 숫자형식으로 된 Subscription ID를 부여받게 되며, 이 ID를 활용하여 기존에 생성한 Webhook을 수정하거나 삭제할 수 있습니다. Webhook은 각 프로토콜-네트워크 쌍의 환경별로 생성할 수 있으며 각각 하나의 Webhook으로 카운트됩니다.

📘

Webhook API는 현재 베타버전으로 지원되고 있습니다.

Web3 Engine의 Webhook API는 현재 베타버전으로 지원되며, Pricing & Throughput 페이지에 별도의 업데이트가 있기 전까지는 기능이 무료로 제공됩니다. 무료 지원 기간동안은 Listener URL이 정상적으로 동작하지 않는 Webhook 또는 하나의 계정에서 과도하게 생성된 Webhook들에 대해 별도의 고지 없이 Webhook의 상태가 비활성화 되거나 삭제될 수 있습니다.

Usecases

• POST createWebhook
  • 원하는 타입의 이벤트를 구독하기 위한 Webhook을 생성할 수 있습니다.
• GET getWebhook
  • subscriptionId로 생성한 Webhook을 조회할 수 있습니다.
• PATCH updateWebhook
  • subscriptionId로 생성한 Webhook의 condition 또는 활성화 여부를 변경할 수 있습니다.
• DELETE deleteWebhook
  • subscriptionId로 생성된 Webhook을 삭제할 수 있습니다.