Skip to main content

Webhook Configuration

Overview​

The system supports configuring Webhook callback addresses to receive key event statuses in the email lifecycle in real-time, helping users complete delivery monitoring, user behavior analysis, and risk control processing.

Features​

  • Asynchronous Push: Webhook events are pushed asynchronously and do not affect the main delivery pipeline
  • Event Subscription: Event types can be configured for subscription to avoid invalid pushes
  • Event Association: A single email may generate multiple events, which need to be associated through MsgId
  • Statistical Error: open / click events have certain statistical errors

Supported Email Event Types​

The system supports the following email event types:

  • Send Event: Email sent successfully or failed
  • Delivery Event: Email delivery status update
  • Open Event: Recipient opens the email
  • Click Event: Recipient clicks links in the email
  • Bounce Event: Email is bounced
  • Complaint Event: Recipient complains about the email

Note: For specific event types and field descriptions, please refer to the Webhook API Documentation.

Configure Webhook​

Setup Steps​

  1. Visit the Console Webhook Settings Page
  2. Enable push functionality
  3. Configure push addresses (up to 3 addresses can be configured):
    • 1 primary address
    • 2 backup addresses
  4. Save the configuration

Push Mechanism​

  • If the primary address fails to receive, the system will try backup addresses in sequence
  • Each address will retry up to 3 times
  • If all addresses fail, the system will log the failure

Disable Push​

If you don't need push notifications, you can disable the push functionality in the console.

Test Webhook​

After configuration, you can click the "Simulate Send Test" button, and the system will push a simulated receipt to help you debug and verify the configuration.

Test Response Example​

The test response Webhook data includes the following information:

  • Event Type: Simulated event type
  • Timestamp: Event occurrence time
  • Email Information: Email ID, subject, and other basic information
  • Status Information: Event status details

Tip: The test response data format is consistent with the actual push data format and can be used to verify whether your receiving interface correctly processes the data.