Fire Custom Event

Fire a custom event to trigger automations and track contact activity.

Use Cases:

• Trigger automations based on custom application events
• Track user actions like purchases, page views, or feature usage
• Send behavioral data to trigger personalized email workflows
• Integrate your application events with email automation

Behavior:

• Event is fired for the specified contact
• Matching automations with event.fired trigger type are activated
• Event properties are available in automation conditions and email templates
• Events are processed asynchronously
• Returns immediately with confirmation

Required Scope: write:contacts

Event Properties:

• eventName (required): Unique event identifier (alphanumeric, underscores, hyphens, dots only)
• contactId (required): ID of the contact this event is for
• properties (optional): Key-value pairs of event data

Event Name Conventions:
Use dot notation for organizing events:

• purchase.completed
• page.viewed
• feature.activated
• subscription.upgraded

Properties Usage:
Properties can be used in automation conditions and email templates:

{
  "eventName": "purchase.completed",
  "contactId": "con_abc123",
  "properties": {
    "orderId": "ORD-12345",
    "amount": 99.99,
    "product": "Premium Plan"
  }
}

Note: Event names are case-sensitive. Use consistent naming conventions across your application.