Skip to main content
POST
/
api
/
automations
/
event
curl --location --request POST 'https://app.audienceful.com/api/automations/event/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
    "event": "custom-event",
    "email": "[email protected]",
    "event_properties": {
        "reset-link": "https://website.com/reset"
    },
    "fields": {
        "custom_field": "value"
    }
  }
}'

{
    "success": true,
    "message": "Successfully triggered event for [email protected]"
}

Documentation Index

Fetch the complete documentation index at: https://developer.audienceful.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Body

​
event
string
required
The event name to trigger
​
email
string
required
The email of the person to trigger the event on
​
event_properties
object
An optional dictionary of event properties. Used for inserting custom content into the email.
​
fields
object
All custom fields for a person

​
Response

​
success
boolean
Whether or not the event was successfully triggered
​
message
boolean
Additional information
curl --location --request POST 'https://app.audienceful.com/api/automations/event/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
    "event": "custom-event",
    "email": "[email protected]",
    "event_properties": {
        "reset-link": "https://website.com/reset"
    },
    "fields": {
        "custom_field": "value"
    }
  }
}'

{
    "success": true,
    "message": "Successfully triggered event for [email protected]"
}