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.

🚧

Events hits through the external API cannot be used to trigger onsite or in-app campaigns.

Example

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/hit/event \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "user_id": 12345,
    "user_attributes": {
      "email": "[email protected]",
      "first_name": "John"
    },
    "event": "purchase",
    "value": {
      "product_name": "Some Product",
      "price": 100
    }
  }'
Language
Click Try It! to start a request and see the response here!