Send an Event

Using external events as triggers in journeys.

POST /api/events/batch/

Send an Event

cURL

curl --request POST \
  --url https://app.laudspeaker.com/api/events/batch/ \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch": [
    {}
  ]
}
'

import requests

url = "https://app.laudspeaker.com/api/events/batch/"

payload = { "batch": [{}] }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({batch: [{}]})
};

fetch('https://app.laudspeaker.com/api/events/batch/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.laudspeaker.com/api/events/batch/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'batch' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.laudspeaker.com/api/events/batch/"

	payload := strings.NewReader("{\n  \"batch\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.laudspeaker.com/api/events/batch/")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batch\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.laudspeaker.com/api/events/batch/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"batch\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

For a walkthrough check out this guide

Authorization · string · required

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

batch · Event[] · required

This field contains the array of events.

An event looks like:

{
      "timestamp": "2024-03-15T02:31:05.295Z",
      "uuid": "F451DF0A-D713-4076-AE20-41AB1641BC98",
      "event": "purchase",
      "source": "mobile",
      "correlationKey": "_id",
      "payload": {
        "cart": true
      },
      "correlationValue": "FBBBCB26-B75E-4342-B40B-568BF879F7C5"
    },

An event must contain an event field (string), correlationKey field (string), correlationValue field (string), and a source set to “custom” and can optionally contain a payload object which contains data you want to send

Examples