This topic describes how to use an HTTP event source to integrate Yuque with EventBridge.

Background information

Developed by Alibaba Group, Yuque is a professional cloud knowledge base that provides knowledge management capabilities for individuals and teams. EventBridge supports fast integration with Yuque for you to manage alerts and events in a centralized manner.



Step 1: Create an event source for Yuque in EventBridge

Create an event source HTTP/HTTPS trigger in the EventBridge console. The following table describes the parameters. For more information, see Create a custom event source of the HTTP/HTTPS Events type.
  • Request Type: Select HTTP&HTTPS.
  • Request Method: Select a POST.
  • Security Configuration: Select Optional.
After the event source is created, you can find the custom event source in the event source list, and then click Details to view the configuration information. Internet request URL can be used as the webhook URL of the event source. pic-1

Step 2: Configure a webhook in Yuque

  1. Log on to the Yuque console and click the name of a knowledge repository.
  2. In the upper-right corner of the page that appears, click the More icon icon and select Settings.
  3. On the Settings page, click Notifications in the left-side navigation pane. On the page that appears, set the following parameters as needed and click Add.
    Add Web Hook
    • Push to: Select Others.
    • Robot name: Enter a name for the robot.
    • Webhook URL: Enter the Internet request URL that is generated in Step 1.
    • Push when the following events occur in book: Select one or more operations as the condition for triggering an event. For example, if you select publishDocument, an event is triggered when you publish a document in the repository.

Step 3: Trigger an event

In the Message Hook List section of the Add Web Hook page, find the webhook that you add in Step 2. Click Test in the Operation column to trigger a test event.

Step 4: Verify the result

  1. Log on to the EventBridge console.
  2. In the top navigation bar, select the region.
  3. In the left-side navigation pane, click Event Buses.
  4. In the left-side navigation pane, click Event Tracking to view and verify the obtained event information.