POST
/
events
/
curl --request POST \
  --url https://api.laudspeaker.com/events/ \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "correlationKey": "<string>",
  "correlationValue": "<string>",
  "event": "<string>",
  "payload": "<any>",
  "source": "<string>"
}'
Authorization
string
required

Header for authenticating with Laudspeaker. Starts with Api-Key followed by the API key, for example Api-Key M4jxXt6diYz1Dds1YmhHe93KGPAUi24PlXgaiRXi.

correlationKey
string
required

This field specifies which user property we use to uniquely identify users. Common choices here include user_id, email, and phone.

correlationValue
string
required

This field is the value that corresponds to the correlationKey, so if the correlationKey is email, then correlationValue could be example@laudspeaker.com.

event
string
required

This the event string that you want to wait on in Laudspeaker. Examples include things like click, change, login, or signup.

payload
json

Further information to pass along with the event, for example if the event is click, the payload might contain the DOM element id that was clicked. You have the ability to further filter events using the payload in the Laudspeaker Journey Builder.

source
string
default: "custom"required

This field is used internally by Laudspeaker to determine what event provider the event is being sent from. When manually sending requests using the API the value is always custom.

Examples