Events API
Overview
With the Events API, you can fire events to the Resonance platform for use in all of your custom
conditions. They can be used to enter users into offers, or to complete offers and referrals.
Sending an event is done be sending a POST request to https://api.resonance-api.com/events/v1/events. The body should be JSON. See the table below for more details.
| URL | https://api.resonance-api.com/events/v1/events |
| Method | POST |
| Authorization Required? | Yes |
Headers
| Key | Value |
|---|---|
| Content-Type | application/json |
| x-api-key | [INSERT YOUR API KEY HERE] |
Payload
| Field | Type | Required? | Description | Examples |
|---|---|---|---|---|
| userId | string | yes | The unique id assigned by your system to the user emitting this event | "foo", "bar", "dbdfe729-6166-49a9-9993-4bbbc9e985a8" |
| name | string | yes | The name of this event | "User Signed Up", "User Activated", "Widget Purchased" |
| eventAt | datetime (as a string) | no | The time this event occurred. Must be a RFC 3339 formatted string. Defaults to the time the server receives the request if not supplied. | "2024-04-12T01:18:37Z" |
| data | object | no | Arbitrary JSON object with custom key value pairs. | { "foo": "bar" } |