Hit event

post

https://api.eu.xtremepush.com/api/external/hit/event

Used to send a realtime event to Xtremepush when an event occurs on a backend system "sign_up", "purchase" etc, similar to the eventHit methods found in the web and mobile SDKs. This allows users to trigger campaigns/workflows based on events that happen outside of sites or Apps.

Body Params

apptoken

string

required

Your App token

user_id

string

required

Your external user ID. If a user with such user ID doesn't exist it will be automatically created.

event

string

required

Event name

value

string

Can be: string / number, eg. 100, or key-value object, eg. {"product": "Some Product"}

user_attributes

json

Key-value array of user attributes. These attributes will be updated before executing any event-triggered campaign. This is useful when the campaign depends on one of the user attributes, such as email address or first name.

timestamp

date-time

The timestamp of the event. By default the timestamp will be read in UTC. If your project is in a different timezone, the timezone can be indicated in the timestamp: 2024-12-13 11:36:00 +01:00.

consent_preferences

json

Optional map of consent preferences by channel. Each channel key must contain a map of preferences with binary values to show their status (1 for opt-in and 0 for opt-out). A metadata object can be included. To update consent preferences, ensure that Consent Manager is enabled for your project.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400