Skip to main content

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:

"recipient@example.com"

​
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:

Response

Event successfully processed or deduplicated