Skip to main content
POST
/
v1
/
events
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "event": "event-name",
  "customer": {
    "source_id": "referee-source_id"
  },
  "referral": {
    "code": "voucher-code",
    "referrer_id": "referrer-source_id"
  }
}'
{
  "object": "event",
  "type": "cart_abandoned",
  "customer": {
    "id": "cust_ypePCF6IU6fnUvec6RMXZuH4",
    "name": "John Doe",
    "email": "john@voucherify.io",
    "source_id": "source_customer_event",
    "metadata": {
      "prop": "value"
    },
    "object": "customer"
  },
  "referral": null,
  "loyalty": null
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

Body

application/json
​
event
string
required
Required string length: 1 - 300
​
customer
object
required
​
referral
object
​
loyalty
object
​
metadata
object

Response

​
object
enum<string>
default:event
required
Available options:
event
​
type
string
required
​
customer
object
required
​
referral
object | null
required
​
loyalty
object | null
required
​
metadata
object
required