Trigger Event

Fires a custom automation event for a contact.

POSThttps://api.audienceful.com/v2/automations/event

curl --location --request POST 'https://api.audienceful.com/v2/automations/event' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>' \
--data-raw '{
    "email": "person@example.com",
    "event": "signed_up",
    "event_properties": {
        "reset-link": "https://website.com/reset"
    },
    "add_person": true,
    "fields": {
        "plan": "pro"
    }
}'

{
  "operation_id": "task-abc123",
  "operation_url": "https://api.audienceful.com/v2/operations/task-abc123",
  "status": "pending",
  "event": "signed_up",
  "email": "person@example.com"
}

Requires the events:write scope. Triggering an event enrolls the contact in any automations whose trigger matches the event name. Processed asynchronously — the response returns immediately with an operation_id.

Body

emailstringrequired

The email of the contact to trigger the event for.

eventstringrequired

The name of the custom event trigger to fire (case-insensitive). Must match an event defined in the workspace — an unknown event returns a 404. List available events with List Automation Events.

event_propertiesobject

An optional dictionary of event properties. These are used for inserting custom content into the emails in the automation that reference a matching data variable.

Properties

example_propertystring

An example property. This value is inserted into emails in the automation that have a matching data variable in the body.

add_personbooleandefault: true

Create the contact if they don't already exist.

fieldsobject

Custom field values to set on the contact, keyed by each field's data_name.

Properties

custom_fieldstring | boolean | number

An example of a custom field you may have for your audience. The data_name for each field is used as the key.

Response

Returns 202 Accepted.

operation_idstring

The id of the async operation.

operation_urlstring

The full URL of the operation — poll it to watch the trigger progress from pending → processing → succeeded.

statusstring

The operation's initial status, pending. Poll the operation to see it move as it is processed.

eventstring

The name of the event that was triggered.

emailstring

The email the event was triggered for.