Skip to main content
POST
/
events
curl --request POST \
  --url https://api.maildiver.com/v1/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_name": "user_signed_up",
  "email": "[email protected]",
  "properties": {
    "user": {
      "profile": {
        "tier": "pro",
        "is_verified": true,
        "credits": 100
      }
    },
    "signup_source": "landing_page",
    "referral_code": "MAILDIVER2025",
    "accepted_terms": true
  }
}
'
{
  "status": "processed",
  "event_id": "0199f234-d327-7cd8-9dc5-4fd8e5e249df",
  "timestamp": "2024-03-15T10:30:45.123Z"
}

Authorizations

​
Authorization
string
header
required

API key with format "Bearer {your-api-key}"

Body

application/json
​
event_name
string
required

Name of the event to trigger.

  • Required, non-empty string
  • Maximum 100 characters
  • Automatically normalized to lowercase and trimmed
Maximum string length: 100
Example:

"user_signed_up"

​
email
string<email>
required

Contact's email address

Maximum string length: 255
Example:

"[email protected]"

​
properties
object

Event properties used for workflow condition matching and email personalization.

Workflow Conditions: Properties enable dynamic workflow branching based on condition rules. Each property can be evaluated using:

  • Comparison: equals, not_equals, greater_than, less_than
  • Text matching: contains, not_contains, begins_with, ends_with
  • Existence: exists, not_exists

Multiple rules can be combined with AND/OR logic for complex conditions.

Supported Types:

  • Strings: "pro", "landing_page"
  • Numbers: 99.99, 1
  • Booleans: true, false
  • Arrays: ["item1", "item2"]

Nested Properties: Use dot notation to access nested values (e.g., "user.profile.tier").

Example Use Case: Send different welcome emails based on subscription plan:

  • If plan equals "pro" → send premium welcome email
  • If plan equals "free" → send standard welcome email
Example:
{
  "plan": "pro",
  "signup_source": "landing_page"
}

Response

Event successfully processed or deduplicated