Sign in
Email Events

Email Held

Triggered when an email is held for review.

Emails may be held due to:

  • Suspicious content detected
  • Policy violations
  • Manual review required

Held emails require manual action in the dashboard to release or delete.

postWebhookMessageHeld

Payload

event'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageBounced' | 'MessageHeld' | 'MessageLoaded' | 'MessageLinkClicked' | 'DomainDNSError' required

The type of event that occurred

timestampinteger required

Unix timestamp when the event occurred

Example payload

{
  "event": "MessageSent",
  "timestamp": 1704672000,
  "payload": {
    "message": {
      "id": "12345",
      "token": "abc123",
      "to": "user@example.com",
      "from": "hello@yourdomain.com",
      "subject": "Welcome to our service",
      "tag": "onboarding",
      "message_id": "<abc123@mail.arkhq.io>",
      "metadata": {
        "user_id": "usr_123456",
        "order_id": "ord_789012"
      }
    },
    "status": "Sent",
    "details": "250 OK",
    "url": "https://yourdomain.com/welcome",
    "ip_address": "203.0.113.45",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
  }
}

Response

Webhook received successfully

Changes